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.
| AccessKey | An identifier required to connect to UPS. |
| AccountNumber | The shipper's account number. |
| DeveloperKey | Identifying part of the authentication key used for the sender's identity. |
| MeterNumber | Meter number to use for submitting requests to the FedEx Server . |
| Password | Password for logging in to the Server . |
| Server | URL for the server where the requests are sent. |
| UserId | 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. |
| LabelImageType | Type of image or printer commands the label is to be formatted in. |
| MasterTrackingNumber | Tracking number assigned to the whole MPS shipment. |
| 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. |
| PackageDangerousGoodsAccessible | Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery. |
| PackageDescription | For FedEx, this is the description that appears in the email to identify 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. |
| 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. |
| PackageSpecialServices | Contains the collection of special services offered on the package level. |
| 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. |
| PayorAccountNumber | The account number of the party responsible for payment (shipping charges, or duties and taxes). |
| PayorCountryCode | The country code for the payor of the shipment, or duties and taxes. |
| PayorType | Method of payment for shipment, or duties and taxes. |
| PayorZipCode | Payor's postal code (if applicable). |
| Provider | Which provider to use. |
| 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. |
| RecipientAddressFlags | Various flags that denote information about the address. |
| RecipientCity | Name of city, town, etc. |
| RecipientCountryCode | Country code. |
| RecipientState | State or province code. |
| RecipientZipCode | Postal code. |
| RecipientCompany | Identifies the contact person's company name. |
| RecipientEmail | Identifies the contact person's email address. |
| RecipientFax | Recipient's fax number. |
| RecipientFirstName | Sender's first name. |
| RecipientLastName | Person's last name. |
| RecipientMiddleInitial | Middle initial. |
| RecipientPhone | Identifies the contact person's phone number. |
| SenderAddress1 | Street name. |
| SenderAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| SenderAddressFlags | Various flags that denote information about the address. |
| SenderCity | Name of city, town, etc. |
| SenderCountryCode | Country code. |
| SenderState | State or province code. |
| SenderZipCode | Postal code. |
| SenderCompany | Identifies the contact person's company name. |
| SenderEmail | Identifies the contact person's email address. |
| SenderFax | Recipient's fax number. |
| 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 | Date package will be mailed. |
| 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. |
| TotalNetCharge | The 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.
| Config | Sets or retrieves a configuration setting . |
| GetShipmentLabels | Generates a shipping label for all packages in the shipment. |
| Reset | Resets 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.
| 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. |
| CSPUserKey | CSP end user key. |
| CSPUserPassword | CSP end user password. |
| CSPProductId | Identifies the CSP product. |
| CSPProductVersion | Identifies the CSP product version. |
| CustomerId | User-assigned number for internal use when using Endicia. |
| LabelOption | Indicates type of label the USPS Server will return. |
| EndiciaInsuranceType | The Insurance type when using Endicia. |
| EndiciaInsuredMail | Used to request Endicia mailpiece insurance. |
| PostageProvider | The postage provider to use. |
| TransactionId | The transaction Id when using Endicia. |
| CODTotalAmount | The total COD amount. |
| CODType | The total COD amount. |
| CODLabel | The total COD amount. |
| CODLabelFile | The total COD amount. |
| HoldAtLocationPhone | Phone number of the FedEx location. |
| HoldAtLocationAddress1 | Street Name of the FedEx location. |
| HoldAtLocationAddress2 | A specific detail of the FedEx location. |
| HoldAtLocationAddressFlags | Flag that donates information about the address. |
| HoldAtLocationCity | Name of city, town, etc. |
| HoldAtLocationCountryCode | Country code of the FedEx location. |
| HoldAtLocationState | State or province code. |
| HoldAtLocationZipCode | Postal code of the FedEx location. |
| HoldAtLocationContactCompany | Identifies the contact company name. |
| HoldAtLocationContactEmail | Identifies the contact person's email address. |
| HoldAtLocationContactFirstName | Identifies the contact person's first name. |
| HoldAtLocationContactLastName | Identifies the contact person's last name. |
| HoldAtLocationContactFax | Identifies the contact person's fax number. |
| HoldAtLocationContactPhone | Identifies the contact person's phone number. |
| HoldAtLocationContactMiddleInitial | Identifies the contact person's middle initial. |
| OriginPostalCode | The Postal Code of the client sending location when using the Canada Post provider. |
| CanadaGroupId | The Group ID number (or group name) to place the created shipment when using Canada Post. |
| CanadaPaymentMethod | The intended payment method when using Canada Post. |
| 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. |