CanadaPostShip Class

Properties Methods Events Configuration Settings Errors

Allows you to generate domestic labels using Canada Post.

Syntax

inship.canadapostship()

Remarks

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

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

Assign each shipment a GroupId and then call GetPackageLabel for each package in the shipment.
Call TransmitShipments with the GroupId for the shipment.
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.


CanadaPostAccountNumber	The shipper's account number.
CanadaPostContractId	This property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.
CanadaPostPassword	Password for logging in to the Server .
CanadaPostServer	URL for the server where the requests are sent.
CanadaPostUserId	User Id for logging in to the Server .
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
GroupId	The Group Id that will be associated with the shipment.
Manifest	Image of the manifest.
ManifestCount	The number of records in the Manifest arrays.
ManifestAccountNumber	This is the 10-digit customer number of who mailed the package(s).
ManifestBaseCharge	This is the total base cost for all shipments on the manifest.
ManifestCCAuthCode	The authorization code received from the credit card issuer.
ManifestCCAuthTimestamp	The date and time that the credit card company authorized the transaction.
ManifestCCMerchantName	The merchant name used when charging the credit card.
ManifestCCMerchantURL	The URL for the merchant who charged the credit card.
ManifestCCNameOnCard	The name on the card that was charged.
ManifestContractId	This is the contract number that was used for pricing this manifest.
ManifestCustomerReference	This is the reference property provided by the client in the transmit shipments request.
ManifestDate	This is the date the manifest was generated.
ManifestDestinationPostalCode	The Postal code of the post office where the shipment is to be dropped off.
ManifestGST	The Good and Services Tax (GST) for all shipments on the manifest.
ManifestHST	The Harmonized Sales Tax (HST) for all shipments on the manifest.
ManifestMediaType	This contains the media-type attribute for the URL .
ManifestNetCharge	This is the total amount due to Canada Post for all shipments on the manifest.
ManifestOriginId	This is the Canada Post identification number of the shipment's origin.
ManifestOriginName	This is the descriptive name of the shipment's origin as printed on the manifest.
ManifestPayorAccountNumber	This is the 10-digit customer number of the customer who is paying for the shipment.
ManifestPONumber	This is the PO number used for billing and will be displayed on the manifest.
ManifestPST	The Provincial Sales Tax (PST) for all shipments on the manifest.
ManifestShipperAccountNumber	This is the 10-digit customer number of the entity for whom the shipment was sent on behalf of.
ManifestTime	This is the time when the manifest was generated.
ManifestTotalDiscount	This is the total discount for all shipments on the manifest.
ManifestTotalSurcharge	This is the total surcharge for all shipments on the manifest.
ManifestURL	This property will contain the URL for the manifest.
ManifestFile	The location where the manifest files will be written.
NotifyCount	The number of records in the Notify arrays.
NotifyEmail	Email address of the recipient to be notified.
NotifyFlags	Identifies the type of notification requested.
OriginPostalCode	The Postal Code of the client sending location when using the Canada Post provider.
PackageCount	The number of records in the Package arrays.
PackageBaseCharge	Base charge applicable to this package.
PackageCODAmount	The COD monetary value for the package.
PackageCODFile	Filename and location to save the CODLabel of this package to.
PackageCODLabel	Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.
PackageCODType	The code that indicates the type of funds that will be used for the COD payment for this package.
PackageHeight	The height of the package to be shipped.
PackageInsuredValue	Amount of insurance requested for this package.
PackageLength	The length of the package to be shipped.
PackageNetCharge	Net charge applicable to this package.
PackageType	The packaging type of the package being rated and/or shipped.
PackageRatingAggregate	Rating aggregate applicable to this package.
PackageReference	Indicates the package reference type and value, that associates this package (assigned by the customer).
PackageReturnReceipt	Image of the receipt for a return shipment.
PackageReturnReceiptFile	Filename and location to save the ReturnReceipt of this package to.
PackageShippingLabel	Image of the shipping label for this package return by the Server upon a successful ship response.
PackageShippingLabelFile	Filename and location to save the ShippingLabel of this package to.
PackageSignatureType	Specifies one of the Delivery Signature Options requested for this package.
PackageSize	Size of the package being mailed.
PackageTotalDiscount	Total discount applicable to this package.
PackageTotalSurcharges	Total surcharges applicable to this package.
PackageTrackingNumber	Tracking number assigned to this package.
PackageWeight	Weight of this package.
PackageWidth	The width of the package to be shipped.
PaymentMethod	The intended payment method when using Canada Post.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
RecipientAddress1	Street name.
RecipientAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientCity	Name of city, town, etc.
RecipientCountryCode	Country code.
RecipientPostalCode	This is identifies of a region (usually small) for mail/package delivery.
RecipientProvince	Province or state code.
RecipientCompany	Identifies the contact person's company name.
RecipientFirstName	Sender's first name.
RecipientLastName	Person's last name.
RecipientMiddleInitial	Middle initial.
RecipientPhone	Identifies the contact person's phone number.
ReturnAddress1	Street name.
ReturnAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
ReturnCity	Name of city, town, etc.
ReturnPostalCode	This is identifies of a region (usually small) for mail/package delivery.
ReturnProvince	Province or state code.
ReturnCompany	Identifies the contact person's company name.
ReturnFirstName	Sender's first name.
ReturnLastName	Person's last name.
ReturnMiddleInitial	Middle initial.
SenderAddress1	Street name.
SenderAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderCity	Name of city, town, etc.
SenderCountryCode	Country code.
SenderPostalCode	This is identifies of a region (usually small) for mail/package delivery.
SenderProvince	Province or state code.
SenderCompany	Identifies the contact person's company name.
SenderFirstName	Sender's first name.
SenderLastName	Person's last name.
SenderMiddleInitial	Middle initial.
SenderPhone	Identifies the contact person's phone number.
ServiceType	Identifies the domestic service to use in a ship request.
ShipDate	The date on which the package will be tendered.
ShipmentId	The unique identifier for this shipment.
ShipmentSpecialServices	Contains the collection of special services offered.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
Timeout	A timeout for the component.

Method List

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


CancelShipment	Cancels a shipment.
Config	Sets or retrieves a configuration setting .
GetManifest	Gets the manifest info and file for the specified manifest.
GetPackageLabel	Generates a shipping label for the specified package.
Reset	Resets the internal state of the component and all properties to their default values.
SearchManifests	Search for manifests within a given date range.
TransmitShipments	Submits the shipment information and retrieve the manifest for the specified GroupId.

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.


Error	Information about errors during data delivery.
Notification	Notification returned by the server upon successful request (if applicable).
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Configuration Settings

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


RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
XPath	Used to retrieve data at any place within the response.
D2POOfficeId	The post office ID where the package should be dropped off.
PaidByCustomer	The customer number of the customer who will be billed for the shipment.
PromoCode	Promotional discount code.
CanadaGstAmount[i]	The amount of Goods and Services Tax (GST) for the service.
CanadaHstAmount[i]	The amount of Harmonized Sales Tax (HST) for the service.
CanadaPstAmount[i]	The amount of Provincial Sales Tax (PST) for the service.
CODIncludePostage	Indicates whether the postage should be included in the COD amount.
CODRecipientAddress1	The primary street address of the COD recipient.
CODRecipientAddress2	The secondary street address of the COD recipient.
CODRecipientCity	The city of the COD recipient.
CODRecipientCompany	The company of the COD recipient.
CODRecipientName	The name of the COD recipient.
CODRecipientPostalCode	The postal code of the COD recipient.
CODRecipientProvince	The province of the COD recipient.
ExcludedShipments	List of shipments to be excluded when closing shipments.
PackageReturnTrackingNumber[i]	The tracking number for the return shipment.
ShowPackagingInstructions	Indicates that the packaging instructions should be shown.
LabelImageType	The type of label to be requested.
LabelSize	The size of the label.
RetryCount	The number of times the component will re-attempt a transaction.
RetryDelay	The amount of time the component will wait before retrying a transaction.
ShipmentVersion	The version of the CanadaPost shipping API to be used.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.