CanadaPostShip Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate domestic labels using Canada Post.

Class Name

DShippingSDK_CanadaPostShip

Procedural Interface

 dshippingsdk_canadapostship_open();
 dshippingsdk_canadapostship_close($res);
 dshippingsdk_canadapostship_register_callback($res, $id, $function);
 dshippingsdk_canadapostship_get_last_error($res);
 dshippingsdk_canadapostship_get_last_error_code($res);
 dshippingsdk_canadapostship_set($res, $id, $index, $value);
 dshippingsdk_canadapostship_get($res, $id, $index);
 dshippingsdk_canadapostship_do_cancelshipment($res, $shipmentid);
 dshippingsdk_canadapostship_do_config($res, $configurationstring);
 dshippingsdk_canadapostship_do_getmanifest($res, $manifestidx);
 dshippingsdk_canadapostship_do_getpackagelabel($res, $packageindex);
 dshippingsdk_canadapostship_do_reset($res);
 dshippingsdk_canadapostship_do_searchmanifests($res, $startdate, $enddate);
 dshippingsdk_canadapostship_do_transmitshipments($res);

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

The shipper's account number.

Object Oriented Interface

public function getCanadaPostAccountNumber();


public function setCanadaPostAccountNumber($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 1 );


dshippingsdk_canadapostship_set($res, 1, $value );

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

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

Object Oriented Interface

public function getCanadaPostContractId();


public function setCanadaPostContractId($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 2 );


dshippingsdk_canadapostship_set($res, 2, $value );

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

Password for logging in to the Server .

Object Oriented Interface

public function getCanadaPostPassword();


public function setCanadaPostPassword($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 3 );


dshippingsdk_canadapostship_set($res, 3, $value );

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

URL for the server where the requests are sent.

Object Oriented Interface

public function getCanadaPostServer();


public function setCanadaPostServer($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 4 );


dshippingsdk_canadapostship_set($res, 4, $value );

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

User Id for logging in to the Server .

Object Oriented Interface

public function getCanadaPostUserId();


public function setCanadaPostUserId($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 5 );


dshippingsdk_canadapostship_set($res, 5, $value );

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

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 6 );


dshippingsdk_canadapostship_set($res, 6, $value );

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

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 7 );


dshippingsdk_canadapostship_set($res, 7, $value );

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

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

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 8 );


dshippingsdk_canadapostship_set($res, 8, $value );

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

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

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 9 );


dshippingsdk_canadapostship_set($res, 9, $value );

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

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

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 10 );


dshippingsdk_canadapostship_set($res, 10, $value );

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

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

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 11 );


dshippingsdk_canadapostship_set($res, 11, $value );

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

The Group Id that will be associated with the shipment.

Object Oriented Interface

public function getGroupId();


public function setGroupId($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 12 );


dshippingsdk_canadapostship_set($res, 12, $value );

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

Image of the manifest.

Object Oriented Interface

public function getManifest();

Procedural Interface

dshippingsdk_canadapostship_get($res, 13 );

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

The number of records in the Manifest arrays.

Object Oriented Interface

public function getManifestCount();

Procedural Interface

dshippingsdk_canadapostship_get($res, 14 );

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

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

Object Oriented Interface

public function getManifestAccountNumber($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 15 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestBaseCharge($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 16 , $manifestidx);

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

The authorization code received from the credit card issuer.

Object Oriented Interface

public function getManifestCCAuthCode($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 17 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestCCAuthTimestamp($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 18 , $manifestidx);

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

The merchant name used when charging the credit card.

Object Oriented Interface

public function getManifestCCMerchantName($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 19 , $manifestidx);

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

The URL for the merchant who charged the credit card.

Object Oriented Interface

public function getManifestCCMerchantURL($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 20 , $manifestidx);

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

The name on the card that was charged.

Object Oriented Interface

public function getManifestCCNameOnCard($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 21 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestContractId($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 22 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestCustomerReference($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 23 , $manifestidx);

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

This is the date the manifest was generated.

Object Oriented Interface

public function getManifestDate($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 24 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestDestinationPostalCode($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 25 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestGST($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 26 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestHST($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 27 , $manifestidx);

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

This contains the media-type attribute for the URL .

Object Oriented Interface

public function getManifestMediaType($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 28 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestNetCharge($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 29 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestOriginId($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 30 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestOriginName($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 31 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestPayorAccountNumber($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 32 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestPONumber($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 33 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestPST($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 34 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestShipperAccountNumber($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 35 , $manifestidx);

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

This is the time when the manifest was generated.

Object Oriented Interface

public function getManifestTime($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 36 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestTotalDiscount($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 37 , $manifestidx);

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

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

Object Oriented Interface

public function getManifestTotalSurcharge($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 38 , $manifestidx);

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

This property will contain the URL for the manifest.

Object Oriented Interface

public function getManifestURL($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 39 , $manifestidx);

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

The location where the manifest files will be written.

Object Oriented Interface

public function getManifestFile();


public function setManifestFile($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 40 );


dshippingsdk_canadapostship_set($res, 40, $value );

Default Value

''

Remarks

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

Data Type

String

NotifyCount Property (DShippingSDK_CanadaPostShip Class)

The number of records in the Notify arrays.

Object Oriented Interface

public function getNotifyCount();


public function setNotifyCount($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 41 );


dshippingsdk_canadapostship_set($res, 41, $value );

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

Email address of the recipient to be notified.

Object Oriented Interface

public function getNotifyEmail($notifyidx);


public function setNotifyEmail($notifyidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 43 , $notifyidx);


dshippingsdk_canadapostship_set($res, 43, $value , $notifyidx);

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

Identifies the type of notification requested.

Object Oriented Interface

public function getNotifyFlags($notifyidx);


public function setNotifyFlags($notifyidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 46 , $notifyidx);


dshippingsdk_canadapostship_set($res, 46, $value , $notifyidx);

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

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

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

For UPS notifications, the following flags apply:

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

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

This field is not used by USPS.

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

This property is not available at design time.

Data Type

Integer

OriginPostalCode Property (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function getOriginPostalCode();


public function setOriginPostalCode($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 48 );


dshippingsdk_canadapostship_set($res, 48, $value );

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

The number of records in the Package arrays.

Object Oriented Interface

public function getPackageCount();


public function setPackageCount($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 49 );


dshippingsdk_canadapostship_set($res, 49, $value );

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

Actual Base Charge applicable to this package.

Object Oriented Interface

public function getPackageBaseCharge($packageidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 50 , $packageidx);

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

The COD monetary value for the package.

Object Oriented Interface

public function getPackageCODAmount($packageidx);


public function setPackageCODAmount($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 51 , $packageidx);


dshippingsdk_canadapostship_set($res, 51, $value , $packageidx);

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

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

Object Oriented Interface

public function getPackageCODFile($packageidx);


public function setPackageCODFile($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 52 , $packageidx);


dshippingsdk_canadapostship_set($res, 52, $value , $packageidx);

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

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

Object Oriented Interface

public function getPackageCODLabel($packageidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 53 , $packageidx);

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

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

Object Oriented Interface

public function getPackageCODType($packageidx);


public function setPackageCODType($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 54 , $packageidx);


dshippingsdk_canadapostship_set($res, 54, $value , $packageidx);

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

The height of the package to be shipped.

Object Oriented Interface

public function getPackageHeight($packageidx);


public function setPackageHeight($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 59 , $packageidx);


dshippingsdk_canadapostship_set($res, 59, $value , $packageidx);

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

Amount of insurance requested for this package.

Object Oriented Interface

public function getPackageInsuredValue($packageidx);


public function setPackageInsuredValue($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 61 , $packageidx);


dshippingsdk_canadapostship_set($res, 61, $value , $packageidx);

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

The length of the package to be shipped.

Object Oriented Interface

public function getPackageLength($packageidx);


public function setPackageLength($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 62 , $packageidx);


dshippingsdk_canadapostship_set($res, 62, $value , $packageidx);

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

Actual Net Charge applicable to this package.

Object Oriented Interface

public function getPackageNetCharge($packageidx);


public function setPackageNetCharge($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 63 , $packageidx);


dshippingsdk_canadapostship_set($res, 63, $value , $packageidx);

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

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

Object Oriented Interface

public function getPackageType($packageidx);


public function setPackageType($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 64 , $packageidx);


dshippingsdk_canadapostship_set($res, 64, $value , $packageidx);

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

Rating aggregate applicable to this package.

Object Oriented Interface

public function getPackageRatingAggregate($packageidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 65 , $packageidx);

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

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

Object Oriented Interface

public function getPackageReference($packageidx);


public function setPackageReference($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 66 , $packageidx);


dshippingsdk_canadapostship_set($res, 66, $value , $packageidx);

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

Image of the receipt for a return shipment.

Object Oriented Interface

public function getPackageReturnReceipt($packageidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 67 , $packageidx);

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

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

Object Oriented Interface

public function getPackageReturnReceiptFile($packageidx);


public function setPackageReturnReceiptFile($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 68 , $packageidx);


dshippingsdk_canadapostship_set($res, 68, $value , $packageidx);

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

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

Object Oriented Interface

public function getPackageShippingLabel($packageidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 69 , $packageidx);

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

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

Object Oriented Interface

public function getPackageShippingLabelFile($packageidx);


public function setPackageShippingLabelFile($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 70 , $packageidx);


dshippingsdk_canadapostship_set($res, 70, $value , $packageidx);

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

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

Object Oriented Interface

public function getPackageSignatureType($packageidx);


public function setPackageSignatureType($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 72 , $packageidx);


dshippingsdk_canadapostship_set($res, 72, $value , $packageidx);

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

Size of the package being mailed.

Object Oriented Interface

public function getPackageSize($packageidx);


public function setPackageSize($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 73 , $packageidx);


dshippingsdk_canadapostship_set($res, 73, $value , $packageidx);

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

Total Actual Discount applicable to this package.

Object Oriented Interface

public function getPackageTotalDiscount($packageidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 75 , $packageidx);

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

Total Actual Surcharges applicable to this package.

Object Oriented Interface

public function getPackageTotalSurcharges($packageidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 76 , $packageidx);

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

Tracking number assigned to this package.

Object Oriented Interface

public function getPackageTrackingNumber($packageidx);

Procedural Interface

dshippingsdk_canadapostship_get($res, 77 , $packageidx);

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

Weight of this package.

Object Oriented Interface

public function getPackageWeight($packageidx);


public function setPackageWeight($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 78 , $packageidx);


dshippingsdk_canadapostship_set($res, 78, $value , $packageidx);

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

The width of the package to be shipped.

Object Oriented Interface

public function getPackageWidth($packageidx);


public function setPackageWidth($packageidx, $value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 79 , $packageidx);


dshippingsdk_canadapostship_set($res, 79, $value , $packageidx);

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

The intended payment method when using Canada Post.

Object Oriented Interface

public function getPaymentMethod();


public function setPaymentMethod($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 80 );


dshippingsdk_canadapostship_set($res, 80, $value );

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

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 81 );


dshippingsdk_canadapostship_set($res, 81, $value );

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

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 82 );


dshippingsdk_canadapostship_set($res, 82, $value );

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

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 83 );


dshippingsdk_canadapostship_set($res, 83, $value );

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

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 84 );


dshippingsdk_canadapostship_set($res, 84, $value );

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

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 85 );


dshippingsdk_canadapostship_set($res, 85, $value );

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

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 86 );


dshippingsdk_canadapostship_set($res, 86, $value );

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

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 87 );


dshippingsdk_canadapostship_set($res, 87, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

RecipientAddress1 Property (DShippingSDK_CanadaPostShip Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 88 );


dshippingsdk_canadapostship_set($res, 88, $value );

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

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

Object Oriented Interface

public function getRecipientAddress2();


public function setRecipientAddress2($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 89 );


dshippingsdk_canadapostship_set($res, 89, $value );

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

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 90 );


dshippingsdk_canadapostship_set($res, 90, $value );

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

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 91 );


dshippingsdk_canadapostship_set($res, 91, $value );

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

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

Object Oriented Interface

public function getRecipientPostalCode();


public function setRecipientPostalCode($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 92 );


dshippingsdk_canadapostship_set($res, 92, $value );

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

Province or state code.

Object Oriented Interface

public function getRecipientProvince();


public function setRecipientProvince($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 93 );


dshippingsdk_canadapostship_set($res, 93, $value );

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

Identifies the contact person's company name.

Object Oriented Interface

public function getRecipientCompany();


public function setRecipientCompany($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 94 );


dshippingsdk_canadapostship_set($res, 94, $value );

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

Sender's first name.

Object Oriented Interface

public function getRecipientFirstName();


public function setRecipientFirstName($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 97 );


dshippingsdk_canadapostship_set($res, 97, $value );

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

Person's last name.

Object Oriented Interface

public function getRecipientLastName();


public function setRecipientLastName($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 98 );


dshippingsdk_canadapostship_set($res, 98, $value );

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

Middle initial.

Object Oriented Interface

public function getRecipientMiddleInitial();


public function setRecipientMiddleInitial($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 99 );


dshippingsdk_canadapostship_set($res, 99, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

RecipientPhone Property (DShippingSDK_CanadaPostShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getRecipientPhone();


public function setRecipientPhone($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 100 );


dshippingsdk_canadapostship_set($res, 100, $value );

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

Street name.

Object Oriented Interface

public function getReturnAddress1();


public function setReturnAddress1($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 101 );


dshippingsdk_canadapostship_set($res, 101, $value );

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

ReturnAddress2 Property (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function getReturnAddress2();


public function setReturnAddress2($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 102 );


dshippingsdk_canadapostship_set($res, 102, $value );

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

ReturnCity Property (DShippingSDK_CanadaPostShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getReturnCity();


public function setReturnCity($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 103 );


dshippingsdk_canadapostship_set($res, 103, $value );

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

ReturnPostalCode Property (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function getReturnPostalCode();


public function setReturnPostalCode($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 105 );


dshippingsdk_canadapostship_set($res, 105, $value );

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 ReturnCity and ReturnProvince are not present.

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

Data Type

String

ReturnProvince Property (DShippingSDK_CanadaPostShip Class)

Province or state code.

Object Oriented Interface

public function getReturnProvince();


public function setReturnProvince($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 106 );


dshippingsdk_canadapostship_set($res, 106, $value );

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 ReturnCountryCode is either CA or US.

Data Type

String

ReturnCompany Property (DShippingSDK_CanadaPostShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getReturnCompany();


public function setReturnCompany($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 107 );


dshippingsdk_canadapostship_set($res, 107, $value );

Default Value

''

Remarks

Identifies the contact person's company name. In a ship request, either ReturnFirstName and ReturnLastName or ReturnCompany are required to be provided.

Data Type

String

ReturnFirstName Property (DShippingSDK_CanadaPostShip Class)

Sender's first name.

Object Oriented Interface

public function getReturnFirstName();


public function setReturnFirstName($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 110 );


dshippingsdk_canadapostship_set($res, 110, $value );

Default Value

''

Remarks

Sender's first name. The value of this property is required. Values for either ReturnFirstName and ReturnLastName or ReturnCompany must be sent.

Data Type

String

ReturnLastName Property (DShippingSDK_CanadaPostShip Class)

Person's last name.

Object Oriented Interface

public function getReturnLastName();


public function setReturnLastName($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 111 );


dshippingsdk_canadapostship_set($res, 111, $value );

Default Value

''

Remarks

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

Data Type

String

ReturnMiddleInitial Property (DShippingSDK_CanadaPostShip Class)

Middle initial.

Object Oriented Interface

public function getReturnMiddleInitial();


public function setReturnMiddleInitial($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 112 );


dshippingsdk_canadapostship_set($res, 112, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderAddress1 Property (DShippingSDK_CanadaPostShip Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();


public function setSenderAddress1($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 114 );


dshippingsdk_canadapostship_set($res, 114, $value );

Default Value

''

Remarks

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

Maximum Length: 44 characters

Data Type

String

SenderAddress2 Property (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function getSenderAddress2();


public function setSenderAddress2($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 115 );


dshippingsdk_canadapostship_set($res, 115, $value );

Default Value

''

Remarks

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

Maximum Length: 44 characters

Data Type

String

SenderCity Property (DShippingSDK_CanadaPostShip Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();


public function setSenderCity($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 116 );


dshippingsdk_canadapostship_set($res, 116, $value );

Default Value

''

Remarks

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

Data Type

String

SenderCountryCode Property (DShippingSDK_CanadaPostShip Class)

Country code.

Object Oriented Interface

public function getSenderCountryCode();


public function setSenderCountryCode($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 117 );


dshippingsdk_canadapostship_set($res, 117, $value );

Default Value

'CA'

Remarks

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

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

Data Type

String

SenderPostalCode Property (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function getSenderPostalCode();


public function setSenderPostalCode($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 118 );


dshippingsdk_canadapostship_set($res, 118, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

SenderProvince Property (DShippingSDK_CanadaPostShip Class)

Province or state code.

Object Oriented Interface

public function getSenderProvince();


public function setSenderProvince($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 119 );


dshippingsdk_canadapostship_set($res, 119, $value );

Default Value

''

Remarks

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

This is required when SenderCountryCode is either CA or US.

Data Type

String

SenderCompany Property (DShippingSDK_CanadaPostShip Class)

Identifies the contact person's company name.

Object Oriented Interface

public function getSenderCompany();


public function setSenderCompany($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 120 );


dshippingsdk_canadapostship_set($res, 120, $value );

Default Value

''

Remarks

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

Data Type

String

SenderFirstName Property (DShippingSDK_CanadaPostShip Class)

Sender's first name.

Object Oriented Interface

public function getSenderFirstName();


public function setSenderFirstName($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 123 );


dshippingsdk_canadapostship_set($res, 123, $value );

Default Value

''

Remarks

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

Data Type

String

SenderLastName Property (DShippingSDK_CanadaPostShip Class)

Person's last name.

Object Oriented Interface

public function getSenderLastName();


public function setSenderLastName($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 124 );


dshippingsdk_canadapostship_set($res, 124, $value );

Default Value

''

Remarks

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

Data Type

String

SenderMiddleInitial Property (DShippingSDK_CanadaPostShip Class)

Middle initial.

Object Oriented Interface

public function getSenderMiddleInitial();


public function setSenderMiddleInitial($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 125 );


dshippingsdk_canadapostship_set($res, 125, $value );

Default Value

''

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (DShippingSDK_CanadaPostShip Class)

Identifies the contact person's phone number.

Object Oriented Interface

public function getSenderPhone();


public function setSenderPhone($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 126 );


dshippingsdk_canadapostship_set($res, 126, $value );

Default Value

''

Remarks

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

Data Type

String

ServiceType Property (DShippingSDK_CanadaPostShip Class)

Identifies the domestic service to use in a ship request.

Object Oriented Interface

public function getServiceType();


public function setServiceType($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 127 );


dshippingsdk_canadapostship_set($res, 127, $value );

Default Value

0

Remarks

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

Valid values for Canada Post are:

This property is not available at design time.

Data Type

Integer

ShipDate Property (DShippingSDK_CanadaPostShip Class)

The date on which the package will be tendered.

Object Oriented Interface

public function getShipDate();


public function setShipDate($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 128 );


dshippingsdk_canadapostship_set($res, 128, $value );

Default Value

''

Remarks

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

Data Type

String

ShipmentId Property (DShippingSDK_CanadaPostShip Class)

The unique identifier for this shipment.

Object Oriented Interface

public function getShipmentId();

Procedural Interface

dshippingsdk_canadapostship_get($res, 129 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ShipmentSpecialServices Property (DShippingSDK_CanadaPostShip Class)

Contains the collection of special services offered.

Object Oriented Interface

public function getShipmentSpecialServices();


public function setShipmentSpecialServices($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 130 );


dshippingsdk_canadapostship_set($res, 130, $value );

Default Value

0

Remarks

To request any of the special services offered by Canada Post in a request, you must set the ShipmentSpecialServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

COD

When set, this will request that the amount specified in PackageCODAmount to be collected on delivery of the package, either in the form of cash, guaranteed funds, or by check, as specified in CODType. After making a call to GetPackageLabel, the COD label will stored in PackageCODLabel, unless PackageCODFile has been set, in which case the label will be saved to the path specified. Note that the label will be in PDF format.

If you want Canada Post to automatically add the postage amount to the CODTotalAmount, you can set the CODIncludePostage configuration setting to True. Also if you wish to have the COD payment returned to a different address than specified in SenderAddress you may specify the address to be printed on the COD return label using the following configuration settings:

• CODRecipientCompany
• CODRecipientName
• CODRecipientAddress1
• CODRecipientAddress2
• CODRecipientCity
• CODRecipientProvince
• CODRecipientPostalCode

Deliver to post office

When this is set, the package will be delivered directly to the Post Office specified by D2POOfficeId and the recipient will be notified that the package is ready to be picked up. When set, the following must also be set:

• RecipientFirstName
• RecipientPhone
• Notify
• D2POOfficeId

This only applies when using the ServiceType is set to stCanadaExpeditedParcel or stCanadaXpresspost.

Return Shipment

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

Card for Pickup

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

Do Not Safe Drop

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

Return at Sender's Expense

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

Return to Sender

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

Abandon

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

Data Type

Long64

SSLAcceptServerCertEncoded Property (DShippingSDK_CanadaPostShip Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 132 );


dshippingsdk_canadapostship_set($res, 132, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DShippingSDK_CanadaPostShip Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 160 );


dshippingsdk_canadapostship_set($res, 160, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 176 );


dshippingsdk_canadapostship_set($res, 176, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 177 );


dshippingsdk_canadapostship_set($res, 177, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (DShippingSDK_CanadaPostShip Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 178 );


dshippingsdk_canadapostship_set($res, 178, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 179 );


dshippingsdk_canadapostship_set($res, 179, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DShippingSDK_CanadaPostShip Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 187 );


dshippingsdk_canadapostship_set($res, 187, $value );

Default Value

0

Remarks

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

Possible values are:

Additional Notes

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

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

Data Type

Integer

SSLServerCertEncoded Property (DShippingSDK_CanadaPostShip Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_canadapostship_get($res, 189 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (DShippingSDK_CanadaPostShip Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_canadapostship_get($res, 216 );


dshippingsdk_canadapostship_set($res, 216, $value );

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class fails with an error.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

CancelShipment Method (DShippingSDK_CanadaPostShip Class)

Cancels a shipment.

Object Oriented Interface

public function doCancelShipment($shipmentid);

Procedural Interface

dshippingsdk_canadapostship_do_cancelshipment($res, $shipmentid);

Remarks

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

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

Config Method (DShippingSDK_CanadaPostShip Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dshippingsdk_canadapostship_do_config($res, $configurationstring);

Remarks

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

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

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

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

GetManifest Method (DShippingSDK_CanadaPostShip Class)

Gets the manifest info and file for the specified manifest.

Object Oriented Interface

public function doGetManifest($manifestidx);

Procedural Interface

dshippingsdk_canadapostship_do_getmanifest($res, $manifestidx);

Remarks

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

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

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

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

GetPackageLabel Method (DShippingSDK_CanadaPostShip Class)

Generates a shipping label for the specified package.

Object Oriented Interface

public function doGetPackageLabel($packageindex);

Procedural Interface

dshippingsdk_canadapostship_do_getpackagelabel($res, $packageindex);

Remarks

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

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

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

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

Reset Method (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_canadapostship_do_reset($res);

Remarks

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

SearchManifests Method (DShippingSDK_CanadaPostShip Class)

Search for manifests within a given date range.

Object Oriented Interface

public function doSearchManifests($startdate, $enddate);

Procedural Interface

dshippingsdk_canadapostship_do_searchmanifests($res, $startdate, $enddate);

Remarks

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

TransmitShipments Method (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function doTransmitShipments();

Procedural Interface

dshippingsdk_canadapostship_do_transmitshipments($res);

Remarks

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

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

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

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

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

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

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

Error Event (DShippingSDK_CanadaPostShip Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_canadapostship_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

Notification Event (DShippingSDK_CanadaPostShip Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_canadapostship_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'message'

Remarks

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

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

SSLServerAuthentication Event (DShippingSDK_CanadaPostShip Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dshippingsdk_canadapostship_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

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

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

SSLStatus Event (DShippingSDK_CanadaPostShip Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dshippingsdk_canadapostship_register_callback($res, 4, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (CanadaPostShip Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

CanadaPostShip Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (CanadaPostShip Class)

CanadaPostShip Errors

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

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