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
nsoftware.InShip.Ezship
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.). |
| Company | Company name of the corresponding sender. |
| Phone | Phone number of the sender. |
| Address1 | Address line 1 of sender. |
| City | City of sender. |
| State | Province or state of sender. |
| ZipCode | Postal Code from which the parcel will be sent. |
| Address1 | Address line 1 of destination. |
| City | City of destination. |
| State | Province or state of destination. |
| CountryCode | The destination country code. |
| ZipCode | The destination Postal Code. Required when shipping to CA or US. Not required for all other international shipments. |
| Weight | The weight of the parcel in kilograms (e.g. 99.999). |
You can optionally set the following fields when requesting rates:
| Length | Longest dimension (3.1 digits e.g. 999.9 pattern). |
| Width | Second longest dimension (3.1 digits e.g. 999.9 pattern). |
| Height | Shortest dimension (3.1 digits e.g. 999.9 pattern). |
| PackagingType | 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. |
| TrackingNumber | The tracking PIN for the shipment. |
| ShippingLabel | 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.
| Account | Login information for the specified Provider . |
| Firewall | A set of properties related to firewall access. |
| LabelImageType | Type of image or printer commands the label is to be formatted in. |
| MasterTrackingNumber | Tracking number assigned to the whole MPS shipment. |
| Packages | A collection of packages contained in the shipment. |
| Payor | Identifies the payor of transportation charges for the requested shipment. |
| Provider | Which provider to use. |
| Proxy | A set of properties related to proxy access. |
| RecipientAddress | Identifies the recipient's address. |
| RecipientContact | Identifies the recipient's 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 | Date package will be mailed. |
| 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. |
| 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. |