CanadaPostShip Component
Properties Methods Events Configuration Settings Errors
Allows you to generate domestic labels using Canada Post.
Syntax
nsoftware.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. 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.
| CanadaPostAccount | Login information for Canada Post. |
| Firewall | A set of properties related to firewall access. |
| GroupId | The Group Id that will be associated with the shipment. |
| Manifest | Image of the manifest. |
| ManifestDetails | The details returned for a manifest. |
| ManifestFile | The location where the manifest files will be written. |
| Notify | Collection of recipients to get notified. |
| OriginPostalCode | The Postal Code of the client sending location when using the Canada Post provider. |
| Packages | A collection of packages contained in the shipment. |
| PaymentMethod | The intended payment method when using Canada Post. |
| Proxy | A set of properties related to proxy access. |
| RecipientAddress | Identifies the recipient's address. |
| RecipientContact | Identifies the recipient's contact info. |
| ReturnAddress | Identifies the return address. |
| ReturnContact | Identifies the return contact info. |
| SenderAddress | Identifies the sender's address. |
| SenderContact | Identifies the sender's contact info. |
| 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. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| Timeout | A 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.
| 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 component 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 component 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. |