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

EzShip Component

Properties   Methods   Events   Configuration Settings   Errors  

Allows you to generate a shipping label for any domestic services complete with addresses and barcode.

Syntax

TibxEzShip

Remarks

The EzShip component provides a standardized interface to all 3 supported carriers. This allows you to reduce the code needed to create an application supporting multiple carriers. For more fine grained control over settings specific to individual carriers you may wish to use the component that is specific to the carrier.

Note that this component is only valid for domestic shipments. If you would like to perform international shipments, you will need to use the international component that is specific to the carrier.

Generating a shipping label can be done by calling the GetShipmentLabels method. You will have to specify the package information, ServiceType to be used for shipping this package, origin and destination information, and any other special services you want to associate the shipment (such as Saturday Pickup, Saturday Delivery, etc.).

To use this component, you must set the appropriate Account settings for the specified Provider.

Canada Post Setup and Required Properties

When retrieving shipping labels via Canada Post, the following fields are required:

UserId The login username for your Canada Post account.
Password The login password for you Canada Post account.
AccountNumber The customer number of the owner of the mail (mailed on behalf of customer).
ServiceType The Canada Post delivery service used for shipping the item (NOTE: Only domestic services are supported.).
SenderCompany Company name of the corresponding sender.
SenderPhone Phone number of the sender.
SenderAddress1 Address line 1 of sender.
SenderCity City of sender.
SenderState Province or state of sender.
SenderZipCode Postal Code from which the parcel will be sent.
RecipientAddress1 Address line 1 of destination.
RecipientCity City of destination.
RecipientState Province or state of destination.
RecipientCountryCode The destination country code.
RecipientZipCode The destination Postal Code. Required when shipping to CA or US. Not required for all other international shipments.
PackageWeight The weight of the parcel in kilograms (e.g. 99.999).

You can optionally set the following fields when requesting rates:

PackageLength Longest dimension (3.1 digits e.g. 999.9 pattern).
PackageWidth Second longest dimension (3.1 digits e.g. 999.9 pattern).
PackageHeight Shortest dimension (3.1 digits e.g. 999.9 pattern).
PackageType Specify a specific packaging type (when applicable).

Note: A shipping label will only be retrieved for the first package within Packages, as multiple package shipments are not supported.

After a successful GetShipmentLabels call, the following fields will be populated:

MasterTrackingNumber A unique identifier for the shipment.
PackageTrackingNumber The tracking PIN for the shipment.
PackageShippingLabel The shipping label data.

The Canada Post URLS are:

Test (Development) https://ct.soa-gw.canadapost.ca
Production https://soa-gw.canadapost.ca

Property List


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

AccessKeyAn identifier required to connect to UPS.
AccountNumberThe shipper's account number.
DeveloperKeyIdentifying part of the authentication key used for the sender's identity.
MeterNumberMeter number to use for submitting requests to the FedEx Server .
PasswordPassword for logging in to the Server .
ServerURL for the server where the requests are sent.
UserIdUser Id for logging in to the Server .
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.
LabelImageTypeType of image or printer commands the label is to be formatted in.
MasterTrackingNumberTracking number assigned to the whole MPS shipment.
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.
PackageDangerousGoodsAccessibleIdentifies whether or not the dangerous goods being shipped are required to be accessible during delivery.
PackageDescriptionFor FedEx, this is the description that appears in the email to identify 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.
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.
PackageSpecialServicesContains the collection of special services offered on the package level.
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.
PayorAccountNumberThe account number of the party responsible for payment (shipping charges, or duties and taxes).
PayorCountryCodeThe country code for the payor of the shipment, or duties and taxes.
PayorTypeMethod of payment for shipment, or duties and taxes.
PayorZipCodePayor's postal code (if applicable).
ProviderWhich provider to use.
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.
RecipientAddress1Street name.
RecipientAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientAddressFlagsVarious flags that denote information about the address.
RecipientCityName of city, town, etc.
RecipientCountryCodeCountry code.
RecipientStateState or province code.
RecipientZipCodePostal code.
RecipientCompanyIdentifies the contact person's company name.
RecipientEmailIdentifies the contact person's email address.
RecipientFaxRecipient's fax number.
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.
SenderAddressFlagsVarious flags that denote information about the address.
SenderCityName of city, town, etc.
SenderCountryCodeCountry code.
SenderStateState or province code.
SenderZipCodePostal code.
SenderCompanyIdentifies the contact person's company name.
SenderEmailIdentifies the contact person's email address.
SenderFaxRecipient's fax number.
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.
ShipDateDate package will be mailed.
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.
TotalNetChargeThe total net charge applied to the whole shipment (specific to the AccountNumber ).

Method List


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

ConfigSets or retrieves a configuration setting .
GetShipmentLabelsGenerates a shipping label for all packages in the shipment.
ResetResets the internal state of the component and all properties to their default values.

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.
CSPUserKeyCSP end user key.
CSPUserPasswordCSP end user password.
CSPProductIdIdentifies the CSP product.
CSPProductVersionIdentifies the CSP product version.
CustomerIdUser-assigned number for internal use when using Endicia.
LabelOptionIndicates type of label the USPS Server will return.
EndiciaInsuranceTypeThe Insurance type when using Endicia.
EndiciaInsuredMailUsed to request Endicia mailpiece insurance.
PostageProviderThe postage provider to use.
TransactionIdThe transaction Id when using Endicia.
CODTotalAmountThe total COD amount.
CODTypeThe total COD amount.
CODLabelThe total COD amount.
CODLabelFileThe total COD amount.
HoldAtLocationPhonePhone number of the FedEx location.
HoldAtLocationAddress1Street Name of the FedEx location.
HoldAtLocationAddress2A specific detail of the FedEx location.
HoldAtLocationAddressFlagsFlag that donates information about the address.
HoldAtLocationCityName of city, town, etc.
HoldAtLocationCountryCodeCountry code of the FedEx location.
HoldAtLocationStateState or province code.
HoldAtLocationZipCodePostal code of the FedEx location.
HoldAtLocationContactCompanyIdentifies the contact company name.
HoldAtLocationContactEmailIdentifies the contact person's email address.
HoldAtLocationContactFirstNameIdentifies the contact person's first name.
HoldAtLocationContactLastNameIdentifies the contact person's last name.
HoldAtLocationContactFaxIdentifies the contact person's fax number.
HoldAtLocationContactPhoneIdentifies the contact person's phone number.
HoldAtLocationContactMiddleInitialIdentifies the contact person's middle initial.
OriginPostalCodeThe Postal Code of the client sending location when using the Canada Post provider.
CanadaGroupIdThe Group ID number (or group name) to place the created shipment when using Canada Post.
CanadaPaymentMethodThe intended payment method when using Canada Post.
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