EzRates Class
Properties Methods Events Configuration Settings Errors
Provides domestic or international rates based on weight, service, and origin/destination information.
Syntax
inship.ezrates()
Remarks
The EzRates class 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 class that is specific to the carrier.
When providing origin, destination information, weight, and service, this class allows a user to obtain a rate quote for a specific service, or a list of available services with the respective rate quotes.
You can send a rate request by calling the GetRates method for:
- a specific service (when RequestedService is specified). In this case, the class will return rates for packages based on a combination of origin, destination, service type, weight, and package type. This also checks if the requested service is available, checks your origin/destination pair and ship date to determine whether the service you requested is a valid service type.
- all available services (when RequestedService is set to UNSPECIFIED, which is the default value) and a specified destination.
When requesting a rate quote, include as much detail as possible about your shipment. This information is important for calculating the correct shipping costs with surcharges.
Rating for a Multiple Package Shipment (MPS) is available for FedEx and UPS, but not USPS.
Please note that all rate quotes are estimates only and may differ from the actual invoiced amount.
To use this class, you must set the appropriate Account settings for the specified Provider.
Canada Post Setup and Required Properties
When retrieving rates via Canada Post, the following fields are required:
| UserId | The login username for your Canada Post account. |
| Password | The login password for your Canada Post account. |
| AccountNumber | The customer number of the owner of the mail (mailed on behalf of customer). |
| SenderZipCode | Postal Code from which the parcel will be sent. |
| 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). |
| RequestedService | A specific service to be rated. If no instances of service-code are included in the request, all services applicable to the shipment and destination will be rated and returned. |
Note: Rates will only be retrieved for the first package within Packages, as multiple package shipments are not supported.
After a successful GetRates call, the following fields will be populated:
| ServiceAccountBaseCharge | Base cost of the shipment before taxes (numeric 99999.99). |
| ServiceAccountNetCharge | Total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes. |
| ServiceAccountTotalDiscount | Total amount of discounts. |
| ServiceAccountTotalSurcharge | Total amount of surcharges. |
| ServiceType | Service type for the mail service being quoted. |
| ServiceTypeDescription | Service name in preferred language. |
| ServiceTransitTime | Indicates the number of days from drop-off or pickup to 1st delivery attempt. |
| ServiceDeliveryDate | The estimated date of delivery, starting from the expected mailing-date. |
| ServiceGuaranteedDescription | Indicates if the delivery date is guaranteed ("true" or "false"). |
| CanadaGstAmount | Goods and services tax (numeric 99999.99). |
| CanadaPstAmount | Provincial sales tax (numeric 99999.99). |
| CanadaHstAmount | Harmonized sales tax (numeric 99999.99). |
Note: Contract based rate quotes are also supported by setting CanadaContractId to your Canada Post Contract ID prior to calling GetRates.
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 class 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. |
| PackageCount | The number of records in the Package arrays. |
| PackageGirth | Measurement around the widest part of the package, perpendicular to the Length . |
| 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. |
| PackageType | The packaging type of the package being rated and/or shipped. |
| PackageSignatureType | Specifies one of the Delivery Signature Options requested for this package. |
| PackageSize | Size of the package being mailed. |
| PackageWeight | Weight of this package. |
| PackageWidth | The width of the package to be shipped. |
| 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. |
| RequestedService | Service type for which the shipping rate is requested. |
| 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. |
| ServiceCount | The number of records in the Service arrays. |
| ServiceAccountBaseCharge | Transportation charges before surcharges and discounts applied to a ServiceType . |
| ServiceAccountNetCharge | Net charge amount applied to a ServiceType . |
| ServiceAccountTotalDiscount | Total discount amount applied to the shipment for a ServiceType . |
| ServiceAccountTotalSurcharge | Total surcharge amount for all additional services applied to a ServiceType . |
| ServiceAggregate | Aggregate of details and rates for the ServiceType in the list of available services. |
| ServiceBusinessDays | Number of business days from origin to destination location. |
| ServiceCommitments | Service commitments for the PackagingType when shipping to CountryCode . |
| ServiceCustomerCenterCutoff | Time the UPS Customer Service Center closes. |
| ServiceDeliveryDate | This indicates the shipment delivery date for the ServiceType . |
| ServiceEffectiveNetDiscount | Indicates the net discount applied to a ServiceType . |
| ServiceListBaseCharge | Transportation charges before surcharges and discounts applied to a ServiceType . |
| ServiceListNetCharge | Net charge amount applied to a ServiceType . |
| ServiceListTotalDiscount | Total discount amount applied to a ServiceType . |
| ServiceListTotalSurcharge | Total surcharge amount for all additional services applied to a ServiceType . |
| ServiceMaxDimensions | Maximum dimensions of a package allowed when sending to the CountryCode . |
| ServiceMaxWeight | Maximum weight of package allowed when sending to the CountryCode . |
| ServiceRateScale | Applicable rate scale for the ServiceType . |
| ServiceRateZone | Applicable rate zone for the ServiceType . |
| ServiceType | Indicates the service type in the list of available services returned. |
| ServiceTypeDescription | Indicates the textual description of a service type in the list of available services returned. |
| ServiceShipTime | Time UPS picks up the package from the origin. |
| ServiceSignatureType | Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType . |
| ServiceTransitTime | Expected number of days in transit from pickup to delivery for the ServiceType . |
| 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. |
| TotalWeight | Total shipment's weight. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| GetRates | Returns rate information for a specified or all available services. |
| 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 class 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 class 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. |
| PostageProvider | The postage provider to use. |
| CanadaContractId | The Contract Id of a Canada Post account used to identify a commercial contract. |
| CanadaGstAmount[i] | The amount of Goods and Services Tax (GST) for the service, specified by 'i', when using Canada Post. |
| CanadaPstAmount[i] | The amount of Provincial Sales Tax (PST) for the service, specified by 'i', when using Canada Post. |
| CanadaHstAmount[i] | The amount of Harmonized Sales Tax (HST) for the service, specified by 'i', when using Canada Post. |
| EndiciaInsuranceType | The Insurance type when using Endicia. |
| EndiciaInsuredMail | Used to request Endicia mailpiece insurance. |
| 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. |