4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

CanadaPostShip Component

Properties   Methods   Events   Configuration Settings   Errors  

Allows you to generate domestic labels using Canada Post.




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. ContractId is set).

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

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

Property List

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

CanadaPostAccountLogin information for Canada Post.
FirewallA set of properties related to firewall access.
GroupIdThe Group Id that will be associated with the shipment.
ManifestImage of the manifest.
ManifestDetailsThe details returned for a manifest.
ManifestFileThe location where the manifest files will be written.
NotifyCollection of recipients to get notified.
OriginPostalCodeThe Postal Code of the client sending location when using the Canada Post provider.
PackagesA collection of packages contained in the shipment.
PaymentMethodThe intended payment method when using Canada Post.
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address.
RecipientContactIdentifies the recipient's contact info.
ReturnAddressIdentifies the return address.
ReturnContactIdentifies the return contact info.
SenderAddressIdentifies the sender's address.
SenderContactIdentifies the sender's contact info.
ServiceTypeIdentifies the domestic service to use in a ship request.
ShipDateThe date on which the package will be tendered.
ShipmentIdThe unique identifier for this shipment.
ShipmentSpecialServicesContains the collection of special services offered.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.

Method List

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

CancelShipmentCancels a shipment.
ConfigSets or retrieves a configuration setting .
GetManifestGets the manifest info and file for the specified manifest.
GetPackageLabelGenerates a shipping label for the specified package.
ResetResets the internal state of the component and all properties to their default values.
SearchManifestsSearch for manifests within a given date range.
TransmitShipmentsSubmits 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 component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
NotificationNotification returned by the server upon successful request (if applicable).
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings

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

RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
XPathUsed to set the XPath within the response from the server.
HasXPathDetermines whether a specific element exists in the document.
XParentThe parent of the current element.
XElementThe name of the current element.
XTextThe text of the current element.
XChildCountThe number of records in the XChild arrays.
XChildElement[i]The name of the indexed child element.
XChildText[i]The text of the indexed child element.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
D2POOfficeIdThe post office ID where the package should be dropped off.
PaidByCustomerThe customer number of the customer who will be billed for the shipment.
PromoCodePromotional discount code.
GetPickupAvailablityUsed to check the availability of pickups.
GetPickupPriceUsed to get pricing for a pickup.
SchedulePickupUsed to schedule a pickup.
GetPickupDetailsUsed to return additional details for a pickup.
GetAllPickupRequestsUsed to return all pickup requests for an account.
UpdatePickupUsed to update a previously scheduled pickup.
CancelPickupUsed to cancel a previously schedule pickup.
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.
CODIncludePostageIndicates whether the postage should be included in the COD amount.
CODRecipientAddress1The primary street address of the COD recipient.
CODRecipientAddress2The secondary street address of the COD recipient.
CODRecipientCityThe city of the COD recipient.
CODRecipientCompanyThe company of the COD recipient.
CODRecipientNameThe name of the COD recipient.
CODRecipientPostalCodeThe postal code of the COD recipient.
CODRecipientProvinceThe province of the COD recipient.
ExcludedShipmentsList of shipments to be excluded when closing shipments.
PackageReturnTrackingNumber[i]The tracking number for the return shipment.
ShowPackagingInstructionsIndicates that the packaging instructions should be shown.
LabelImageTypeThe type of label to be requested.
LabelSizeThe size of the label.
RetryCountThe number of times the component will re-attempt a transaction.
RetryDelayThe amount of time the component will wait before retrying a transaction.
ShipmentVersionThe version of the CanadaPost shipping API to be used.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]