Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

CanadaPostShipIntl Component

Properties   Methods   Events   Configuration Settings   Errors  

Allows you to generate international labels using Canada Post.

Syntax

TibxCanadaPostShipIntl

Remarks

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

You should also specify the Commodities for all packages. Note that Canada Post will use this information to generate a commercial invoice, which will be returned to you in PDF format in the InternationalForm property, unless InternationalFormFile is set, in which case the file will be saved to the path specified.

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 component 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 component with short descriptions. Click on the links for further details.

CanadaPostAccountNumberThe shipper's account number.
CanadaPostContractIdThis property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.
CanadaPostPasswordPassword for logging in to the Server .
CanadaPostServerURL for the server where the requests are sent.
CanadaPostUserIdUser Id for logging in to the Server .
CommodityCountThe number of records in the Commodity arrays.
CommodityDescriptionComplete and accurate description of this commodity line item.
CommodityHarmonizedCodeUnique code representing this commodity line item (for imports only).
CommodityManufacturerCountry code where the contents of this commodity line were produced, manufactured or grown in their final form.
CommodityNumberOfPiecesThe total number of packages, cartons, or containers for the commodity line item.
CommodityUnitPriceValue of each QuantityUnit in Quantity of this commodity line item.
CommodityWeightThe shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
GroupIdThe Group Id that will be associated with the shipment.
InternationalFormImage of the international form.
InternationalFormFileThe location where the international form files will be written.
ManifestImage of the manifest.
ManifestCountThe number of records in the Manifest arrays.
ManifestAccountNumberThis is the 10-digit customer number of who mailed the package(s).
ManifestBaseChargeThis is the total base cost for all shipments on the manifest.
ManifestCCAuthCodeThe authorization code received from the credit card issuer.
ManifestCCAuthTimestampThe date and time that the credit card company authorized the transaction.
ManifestCCMerchantNameThe merchant name used when charging the credit card.
ManifestCCMerchantURLThe URL for the merchant who charged the credit card.
ManifestCCNameOnCardThe name on the card that was charged.
ManifestContractIdThis is the contract number that was used for pricing this manifest.
ManifestCustomerReferenceThis is the reference property provided by the client in the transmit shipments request.
ManifestDateThis is the date the manifest was generated.
ManifestDestinationPostalCodeThe Postal code of the post office where the shipment is to be dropped off.
ManifestGSTThe Good and Services Tax (GST) for all shipments on the manifest.
ManifestHSTThe Harmonized Sales Tax (HST) for all shipments on the manifest.
ManifestMediaTypeThis contains the media-type attribute for the URL .
ManifestNetChargeThis is the total amount due to Canada Post for all shipments on the manifest.
ManifestOriginIdThis is the Canada Post identification number of the shipment's origin.
ManifestOriginNameThis is the descriptive name of the shipment's origin as printed on the manifest.
ManifestPayorAccountNumberThis is the 10-digit customer number of the customer who is paying for the shipment.
ManifestPONumberThis is the PO number used for billing and will be displayed on the manifest.
ManifestPSTThe Provincial Sales Tax (PST) for all shipments on the manifest.
ManifestShipperAccountNumberThis is the 10-digit customer number of the entity for whom the shipment was sent on behalf of.
ManifestTimeThis is the time when the manifest was generated.
ManifestTotalDiscountThis is the total discount for all shipments on the manifest.
ManifestTotalSurchargeThis is the total surcharge for all shipments on the manifest.
ManifestURLThis property will contain the URL for the manifest.
ManifestFileThe location where the manifest files will be written.
NotifyCountThe number of records in the Notify arrays.
NotifyEmailEmail address of the recipient to be notified.
NotifyFlagsIdentifies the type of notification requested.
OriginPostalCodeThe Postal Code of the client sending location when using the Canada Post provider.
PackageCountThe number of records in the Package arrays.
PackageBaseChargeBase charge applicable to this package.
PackageCODAmountThe COD monetary value for the package.
PackageCODFileFilename and location to save the CODLabel of this package to.
PackageCODLabelImage of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.
PackageCODTypeThe code that indicates the type of funds that will be used for the COD payment for this package.
PackageHeightThe height of the package to be shipped.
PackageInsuredValueAmount of insurance requested for this package.
PackageLengthThe length of the package to be shipped.
PackageNetChargeNet charge applicable to this package.
PackageTypeThe packaging type of the package being rated and/or shipped.
PackageRatingAggregateRating aggregate applicable to this package.
PackageReferenceIndicates the package reference type and value, that associates this package (assigned by the customer).
PackageReturnReceiptImage of the receipt for a return shipment.
PackageReturnReceiptFileFilename and location to save the ReturnReceipt of this package to.
PackageShippingLabelImage of the shipping label for this package return by the Server upon a successful ship response.
PackageShippingLabelFileFilename and location to save the ShippingLabel of this package to.
PackageSignatureTypeSpecifies one of the Delivery Signature Options requested for this package.
PackageSizeSize of the package being mailed.
PackageTotalDiscountTotal discount applicable to this package.
PackageTotalSurchargesTotal surcharges applicable to this package.
PackageTrackingNumberTracking number assigned to this package.
PackageWeightWeight of this package.
PackageWidthThe width of the package to be shipped.
PaymentMethodThe intended payment method when using Canada Post.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
ReasonForExportThe reason for the export.
RecipientAddress1Street name.
RecipientAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientCityName of city, town, etc.
RecipientCountryCodeCountry code.
RecipientPostalCodeThis is identifies of a region (usually small) for mail/package delivery.
RecipientProvinceProvince or state code.
RecipientCompanyIdentifies the contact person's company name.
RecipientFirstNameSender's first name.
RecipientLastNamePerson's last name.
RecipientMiddleInitialMiddle initial.
RecipientPhoneIdentifies the contact person's phone number.
SenderAddress1Street name.
SenderAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderCityName of city, town, etc.
SenderCountryCodeCountry code.
SenderPostalCodeThis is identifies of a region (usually small) for mail/package delivery.
SenderProvinceProvince or state code.
SenderCompanyIdentifies the contact person's company name.
SenderFirstNameSender's first name.
SenderLastNamePerson's last name.
SenderMiddleInitialMiddle initial.
SenderPhoneIdentifies the contact person's phone number.
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.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
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 retrieve data at any place within the response.
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.
CommodityOriginProvince[i]The province the commodity originated in.
CommoditySKU[i]The SKU for the commodity.
CommodityUnitMeasure[i]The unit of measure for the commodity.
LicenceNumberThe number of the government/agency import or export license.
InvoiceNumberThe commercial invoice number.
CertificateNumberThe number of the government/agency certificate or permit.
ConversionFromCADThe conversion rate from CAD.
CurrencyCodeThe currency code associated with the monetary values present in the request.
ReasonForExportDescriptionThe description for the reason for export.
ShowInsuredValueIndicates that the insured value should be shown.
ShowPostageRateIndicates that the postage rate should be shown.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
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.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
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.
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.
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).
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 TCP 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.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0