USPSShipIntl Class
Properties Methods Events Config Settings Errors
Allows you to generate a USPS shipping label for any of USPS international services complete with addresses and barcode. Note that when PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. The eVS International Label API lets customers generate eVS labels with integrated customs declaration forms.
Syntax
dshippingsdk.Uspsshipintl
Remarks
Generating a shipping label can be done by calling the GetPackageLabel method. You will have to specify the package information, USPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Return Shipment, etc.), and any other specific information on international shipments.
Postage Provider Notes
ppNoneWhen using USPS as the PostageProvider (i.e. ppNone) you will need to...
- Set PostageProvider to ppNone (default).
- Set UserId to the UserId provided by USPS.
- Set Password to the password provided by USPS.
- Set Server to either the test or production server.
When using Endicia as the PostageProvider there are different instructions for Production and Testing.
Production
Endicia will provide you with a production account number and password. To use your account with the components...
- Set PostageProvider to ppEndicia.
- Set AccountNumber to your production account number (provided by Endicia).
- Set Password to your production password (provided by Endicia).
The components come with a built in sandbox account for your use. To use that account with the components...
- Set PostageProvider to ppEndicia.
- Set EndiciaTestMode to either 1 or 2.
ppStamps
When using Stamps.com as the PostageProvider you will need to...
- Set PostageProvider to ppStamps.
- Set UserId to the sandbox or production user provided by Stamps.com.
- Set AccountNumber to the sandbox or production account number provided by Stamps.com.
- Set Password to the sandbox or production password provided by Stamps.com.
- Set Server to either the test or production server.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
BarcodeNumber | Barcode number associated with label's barcode. |
CertificateNumber | Certificate number (if known or included in the package). |
Comments | Comments on the package being shipped. |
Commodities | Items being shipped inside this package. |
Contents | Type of the contents in the package. |
CustomerId | User-assigned number for internal use. |
ExtraServices | Contains the collection of extra services offered by USPS on shipment level. |
Firewall | A set of properties related to firewall access. |
ImageLayout | Determines how the labels will be formatted for printing. |
ImportersContact | Identifies the importer's contact info. |
IndemnityCoverage | Indicates the indemnity coverage for the package. |
InsurancePolicy | Insurance number, if known. |
InvoiceNumber | Invoice number if known or included in the package. |
LabelImageType | Type of label image. |
LicenseNumber | Import License number if known, or included in package. |
Machinable | Indicates if shipment is machinable or not. |
MailingLocation | Postal Office Zip Code where the item will be mailed (if different from ZipCode ). |
NonDeliveryOption | Indicates what to do with the package in case it is undeliverable. |
Notes | Additional information returned by the USPS Server . |
Observations | Additional mailing information based on country of destination. |
Packages | A collection of packages contained in the shipment. |
PermitNumber | Permit number to print Postage Due labels. |
PostageProvider | The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used. |
PriceOption | Indicates pricing that should be returned (i.e. Commercial Base). |
Prohibitions | List of items prohibited from mailing to the destination country. |
Proxy | This property includes a set of properties related to proxy access. |
RecipientAddress | Identifies the recipient's address. |
RecipientContact | Identifies the recipient's contact info. |
RecipientCustomsReference | Corresponds to the person's Customs Reference field that appears on the shipping label. |
Regulations | Additional regulations for shipping to the destination country. |
Restrictions | Restrictions on items being shipped based on country of destination. |
SDRValue | Special Drawing Right calculated on TotalValue . |
SenderAddress | Identifies the sender's address. |
SenderContact | Identifies the sender's contact info. |
SenderCustomsReference | Corresponds to the person's Customs Reference field that appears on the shipping label. |
ServiceType | The mail service type when shipping to the CountryCode . |
ShipDate | Date package will be mailed. |
ShipmentSpecialServices | Contains the collection of special services offered by USPS on shipment level. |
SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
Timeout | A timeout for the class. |
TotalValue | Total value of all items being shipped. |
TransactionId | The transaction Id. |
USPSAccount | Login information for USPS. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
CancelPackage | Cancels a single package by deleting it from the eVS shipping log. |
Config | Sets or retrieves a configuration setting. |
GetPackageLabel | Generates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. |
Reset | Resets the internal state of the class 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. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
ActionCode | Use to specify the Action Code. |
AddOnAggregate[i] | Indicates the AddOn raw XML. |
AddOnAmount[i] | Indicates the AddOn amount. |
AddOnCount | Total number of AddOns. |
AddOnType[i] | Indicates the AddOn type. |
AddOnTypeDescription[i] | Indicates the AddOn description. |
AddOnTypes | The AddOn type to be requested. |
AltReturnAddress1 | Alternate return address 1. |
AltReturnAddress2 | Alternate return address 2. |
AltReturnCountry | Alternate return country. |
APOFPOServiceType | APO/FPO Service Type for Military Mail and US territories (Except Puerto Rico and US Virgin Islands which are considered domestic). |
Certify | Certify/Test mode for label classes. |
CommercialPrice | Indicates whether the commercial price should be returned. |
CommodityItemCode[i] | Item code representing the commodity line item. |
CRID | Customer Registration ID. |
CustomerId2 | User-assigned number for internal use. Corresponds to the CustomerRefNo2 tag of the eVS label API. |
CustomsFormType | The customs form type of the label. |
CustomsSigner | The name of the person certifying the customs information is correct. |
DeclaredValue | The amount to declare. |
DestinationRateIndicator | Destination rate indicator for eVS International labels. |
EELPFC | Exemption and Exclusion Legend or PFC Code. |
EndiciaHazMatDescription | HazMat Description. |
EndiciaHazMatPhone | HazMat phone number. |
EndiciaInsuranceType | The Insurance type when using Endicia. |
EndiciaPrintConsolidatorLabel | Used to request Consolidator Services. |
EndiciaTestMode | Controls whether requests are test requests or live requests. |
EndiciaValidateAddress | Defines if the address should be validated or not. |
EntryFacility | Postal facility where mail is entered. |
EscapeEndiciaXML | Whether to escape XML special characters when using Endicia. |
HasXPath | Determines whether a specific element exists in the document. |
HoldForManifest | Holds manifest record for inclusion in SCAN request. |
ImageParameters | For future use. |
ImportersReferenceType | Importer's Reference Type for eVS International labels. |
IncludePostage | Used to determine if the postage will be printed on the label. |
IntegratorTxId | Stamps.com transaction integrator Id. |
LabelImageResolution | The resolution of the label. |
LabelImageRotation | The rotation of the label. |
LabelSize | The size of the label. |
LogisticsManagerMID | Logistics Manager Mailer ID. |
Memo | Customer defined data to be printed on a Stamps shipping label. |
MeterPayment | Meter payment indicator. |
MID | Mailer ID. |
OptOutOfSPE | Opt out of Shipping Partner Event file creation. |
OtherContents | Description of the contents. |
Overwrite | Determines whether label files will be overwritten. |
PackageLabelUrl | Stams.com label Url. |
PackageShippingLabelCount[i] | Total number of labels and / or custom forms returned in the response for each package. |
PackageShippingLabelIndex[i] | Image of the shipping label return by the Server upon a successful ship response for each package. |
POZipCode | ZIP Code of Post Office. |
RawRequest | Contains the complete request sent to the Server. |
RawResponse | Contains the complete response returned by the Server. |
RecipientAddress3 | Recipient's address line 3. |
RecipientAddress4 | Recipient's address line 4. |
RecipientAPOFPOZip | APO/FPO ZIP code for Military Mail. |
RecipientAPOFPOZip4 | APO/FPO ZIP4 code for Military Mail. |
RecipientTaxId | Tax Id for the recipient. |
RedirectAddress | Redirect Address. |
RedirectCity | Redirect City. |
RedirectEmail | Redirect Email. |
RedirectName | Redirect Name. |
RedirectSMS | Redirect SMS. |
RedirectState | Redirect State. |
RedirectZip4 | Redirect ZIP4 extension. |
RedirectZipCode | Redirect ZIP Code. |
RegisteredMailValue | The value of registered mail sent in the request. |
RequestId | The ID used to identify a particular request/response pair when tracking Endicia packages. |
RubberStamp1 | Customer defined data to be printed on label. |
RubberStamp2 | Customer defined data to be printed on label. |
RubberStamp3 | Customer defined data to be printed on label. |
SCANFormImage | Image of the PS Form 3152 or PS Form 5630. |
SCANFormImageFile | The location where the SCAN Form Image will be written. |
SCANFormNumber | Returns the Form Number from the last succesful call to USPSCreateManifest. |
SCANFormType | Indicates the SCAN Form Type that should be returned when calling USPSCreateManifest. |
SCANPackageBarcodes | A list of Package Barcodes to include in the SCAN Request (create a manifest for). |
SenderUrbanization | The Urbanization that the package is being shipped from. |
ShipTime | Time package will be mailed. |
SortType | Sort level for applicable mail classes. |
StampsAPIVersion | Controls the API version used for requests. |
StampsCreateManifest | Sends a request to create a manifest for the specified shipments. |
StampsCreateManifestId | Returns the ManifestId from the last succesful call to StampsCreateManifest. |
StampsCreateManifestIdentifier | A list of identifiers to create a manifest for. |
StampsCreateManifestIdentifierType | Used to indicate the type of identifier used. |
StampsTestMode | Controls whether requests are test requests or live requests. |
StampsTxId | Stamps.com transaction identifier. |
UseInsurance | Specifies whether or not to request insurance. |
UseStealth | Used to determine if the postage price is printed on the label. |
USPSCreateManifest | Sends a SCAN request to create a manifest for the specified shipments. |
VendorCode | Vendor Code to identify the developer of the shipping system. |
VendorProductVersionNumber | Vendor Product Version Number. |
XAttrCount | The number of records in the XAttr arrays. |
XAttrName[i] | The name of the indexed attribute. |
XAttrValue[i] | The value of the indexed attribute. |
XChildCount | The number of records in the XChild arrays. |
XChildElement[i] | The name of the indexed child element. |
XChildText[i] | The text of the indexed child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Used to set the XPath within the response from the server. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
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. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
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. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the class will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the class binds to a SOCKS firewall as a server (TCPClient only). |
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. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
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 port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLContextProtocol | The protocol used when getting an SSLContext instance. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
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. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the class whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
BarcodeNumber Property (USPSShipIntl Class)
Barcode number associated with label's barcode.
Syntax
public String getBarcodeNumber();
Default Value
""
Remarks
The value of this property is filled after a call to the GetPackageLabel method when using the eVS Label API (in other words PostageProvider is set to ppNone).
This property is read-only.
CertificateNumber Property (USPSShipIntl Class)
Certificate number (if known or included in the package).
Syntax
public String getCertificateNumber(); public void setCertificateNumber(String certificateNumber);
Default Value
""
Remarks
Some countries require a Certificate of Origin in order for certain items to be imported. (for example, fruits and vegetables). Restrictions as to what items require a Certificate Of Origin are returned in the Restrictions property.
The value of this property is optional. Maximum length: 24.
This property is not applicable for International First Class mail.
Comments Property (USPSShipIntl Class)
Comments on the package being shipped.
Syntax
public String getComments(); public void setComments(String comments);
Default Value
""
Remarks
Optional comments field. Maximum length: 76.
This property is not applicable for International First Class mail.
Commodities Property (USPSShipIntl Class)
Items being shipped inside this package.
Syntax
public CommodityDetailList getCommodities(); public void setCommodities(CommodityDetailList commodities);
Remarks
This property should be set to the commodity types that are inside the package. Each commodity has a Description, HarmonizedCode, Manufacturer, Quantity, UnitPrice, and Weight.
For instance, to send a package containing 20 wheel bearings and 15 fork seals:
class.Commodities.Add(new CommodityDetail());
class.Commodities.Add(new CommodityDetail());
class.Commodities[0].Description = "Wheel bearings";
class.Commodities[0].Quantity = 20;
class.Commodities[0].Value = "100.00"; // 20 bearings at $5 each
class.Commodities[0].Weight = "10 lbs 0 oz"; // each wheel bearing is .5 lbs
class.Commodities[1].Description = "Fork seals";
class.Commodities[1].Quantity = 15;
class.Commodities[1].Value = "375.00"; // 15 seals at $25 each
class.Commodities[1].Weight = "3 lbs 8 oz"; // Total weight of all fork seals in the package.
Please note that Manufacturer and HarmonizedCode are only valid for commercial shippers, and may be left out. The remaining fields are all required.
This property is not available at design time.
Contents Property (USPSShipIntl Class)
Type of the contents in the package.
Syntax
public int getContents(); public void setContents(int contents); Enumerated values: public final static int ctSample = 0; public final static int ctGift = 1; public final static int ctDocuments = 2; public final static int ctReturn = 3; public final static int ctOther = 4; public final static int ctMerchandise = 5; public final static int ctHumanitarianDonation = 6; public final static int ctDangerousGoods = 7; public final static int ctCrematedRemains = 8; public final static int ctNonNegotiableDocument = 9; public final static int ctPharmaceuticals = 10; public final static int ctMedicalSupplies = 11; public final static int ctHAZMAT = 12; public final static int ctLives = 13; public final static int ctPerishable = 14;
Default Value
0
Remarks
You can set this property when generating labels to indicate the content type in the package.
Possible values are as follows:
Value | Endicia & Stamps International | USPS (eVS International) | USPS (eVS Domestic) | |
ctSample (0) | X | X | ||
ctGift (1) | X | X | ||
ctDocuments (2) | X | X | ||
ctReturn (3) | X | X | ||
ctOther (4) | X | X | ||
ctMerchandise (5) | X | X | ||
ctHumanitarianDonation (6) | X | X | ||
ctDangerousGoods (7) | X | X | ||
ctCrematedRemains (8) | X | X | ||
ctNonNegotiableDocument (9) | X | |||
ctPharmaceuticals (10) | X | X | ||
ctMedicalSupplies (11) | X | X | ||
ctHAZMAT (12) | X | |||
ctLives (13) | X | |||
ctPerishable (14) | X |
Note that if Contents is set to ctOther, you may be required to set the OtherContents configuration setting with a description of the contents. For example:
class.Contents = ctOther
class.Config("OtherContents=Livestock")
CustomerId Property (USPSShipIntl Class)
User-assigned number for internal use.
Syntax
public String getCustomerId(); public void setCustomerId(String customerId);
Default Value
""
Remarks
You can set a value to CustomerId property if you have a need to cross-reference information about a shipment using your own tracking or inventory systems. Any combination of alpha and numeric characters can be entered, up to a maximum of 30.
Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId value on the shipping label image if you set the PrintCustomerRefNo to True. In all other cases this string will not be included on the label.
For Endicia requests, this is a unique Id for the partner's end-user that is printing the label.
ExtraServices Property (USPSShipIntl Class)
Contains the collection of extra services offered by USPS on shipment level.
Syntax
public long getExtraServices(); public void setExtraServices(long extraServices);
Default Value
0
Remarks
To request any of the extra services offered by USPS, you must set the ExtraServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:
Value | Meaning |
0x00000001L | Certified Mail |
0x00000002L | Certified Mail Restricted Delivery |
0x00000004L | Certified Mail Adult Signature Required |
0x00000008L | Certified Mail Adult Signature Restricted Delivery |
0x00000010L | Insurance |
0x00000020L | Insurance PME |
0x00000040L | Insurance PM |
0x00000080L | Insurance Restricted Delivery |
0x00000100L | Insurance Restricted Delivery PME |
0x00000200L | Insurance Restricted Delivery PM |
0x00000400L | Return Receipt |
0x00000800L | Return Receipt Electronic |
0x00001000L | Return Receipt Express Mail |
0x00002000L | Adult Signature |
0x00004000L | Adult Signature Restricted Delivery |
0x00008000L | Signature Confirmation Electronic |
0x00010000L | Signature Confirmation Electronic Restricted Delivery |
0x00020000L | Scan Retention |
0x00040000L | Scan and Signature Retention |
0x00080000L | Special Handling Fragile |
0x00100000L | 10:30 AM Delivery PME |
0x00200000L | USPS Tracking Electronic |
0x00400000L | Electronic USPS Delivery Confirmation International |
Firewall Property (USPSShipIntl Class)
A set of properties related to firewall access.
Syntax
public Firewall getFirewall(); public void setFirewall(Firewall firewall);
Remarks
This is a Firewall type property which contains fields describing the firewall through which the class will attempt to connect.
ImageLayout Property (USPSShipIntl Class)
Determines how the labels will be formatted for printing.
Syntax
public int getImageLayout(); public void setImageLayout(int imageLayout); Enumerated values: public final static int ilOnePerFile = 0; public final static int ilAllInOneFile = 1; public final static int ilTrimOnePerFile = 2; public final static int ilTrimAllInOneFile = 3;
Default Value
0
Remarks
The LabelImageType property indicates the file type of the label that USPS returns. ImageLayout dictates how the label looks in that file. The labels returned by USPS measure 8.5" x 5.5", or exactly one half of a sheet of regular 8.5" x 11" paper. The layouts available are listed below:
ilOnePerFile (0) | Each label is returned as a separate file. The label takes up the top half of the paper, and the bottom half is left blank. |
ilAllInOneFile (1) | All the labels are returned in one file. Each label takes up the top half of a piece of paper, and the bottom half is left blank. |
ilTrimOnePerFile (2) | Labels are returned two to a file. If there are six pages of labels, then there will be only three files. Each file has a label on both the top and bottom half of the paper. |
ilTrimAllInOneFile (3) | All the labels are returned in one file. No blank space is left on the pages. |
For the ilAllInOneFile and ilTrimAllInOneFile ImageLayouts, only one file will be written. However, for the ilOnePerFile and ilTrimOnePerFile ImageLayouts, more than one shipping label may be returned, up to a maximum of 6 total pages. If ShippingLabelFile is specified, these additional pages will be saved with the page number appended to the ShippingLabelFile you supplied.
For instance, if the ShippingLabelFile is "c:\expresslabel.pdf", the following files will be created: "expresslabel.pdf", "expresslabel.page2.pdf", "expresslabel.page3.pdf", etcetera.
Note that for the stUSPSFirstClass ServiceType, only ilOnePerFile and ilAllInOneFile are supported. Using any of the Trim-values will result in an error from USPS.
ImportersContact Property (USPSShipIntl Class)
Identifies the importer's contact info.
Syntax
public ContactDetail getImportersContact(); public void setImportersContact(ContactDetail importersContact);
Remarks
The ImportersContact represents contact data identifying the importer. It can be provided in an international ship request only when the ServiceType is stUSPSExpressMailInternational (82) or stUSPSPriorityMailInternational (84).
The only necessary fields to be set for this type are the Email, Fax, and Phone.
This must be set to an instance of the ContactDetail type. See the ContactDetail type for more information.
IndemnityCoverage Property (USPSShipIntl Class)
Indicates the indemnity coverage for the package.
Syntax
public String getIndemnityCoverage();
Default Value
""
Remarks
This property is returned only for International Priority Mail packages, and only when the InsuredValue property was set to an amount greater than "0.00".
This property is read-only.
InsurancePolicy Property (USPSShipIntl Class)
Insurance number, if known.
Syntax
public String getInsurancePolicy(); public void setInsurancePolicy(String insurancePolicy);
Default Value
""
Remarks
If insurance has been purchased, this property should be set to the policy number.
This property is not applicable for International First Class mail.
InvoiceNumber Property (USPSShipIntl Class)
Invoice number if known or included in the package.
Syntax
public String getInvoiceNumber(); public void setInvoiceNumber(String invoiceNumber);
Default Value
""
Remarks
This property may contain an invoice number if it is known or included in the package. Maximum length is 24 characters. This property is ignored when PackagingType is set to scFlatRateEnvelope.
This property is not applicable for International First Class mail.
LabelImageType Property (USPSShipIntl Class)
Type of label image.
Syntax
public int getLabelImageType(); public void setLabelImageType(int labelImageType); Enumerated values: public final static int sitNone = 0; public final static int sitTIF = 1; public final static int sitJPG = 2; public final static int sitPDF = 3; public final static int sitGIF = 4; public final static int sitEPL = 5; public final static int sitPNG = 6; public final static int sitZPL = 7; public final static int sitPDFVector = 8; public final static int sitPDFVectorWithFonts = 9; public final static int sitAZPL = 10;
Default Value
0
Remarks
The value of this property is required when calling methods to retrieve shipping labels. Valid image formats are listed below:
sitNone (0) | Enter sitNone if a label is not desired. (Only the TrackingNumber will be returned). |
sitTIF (1) | Tagged Image File format (bitmap). |
sitJPG (2) | Joint Photographic expert Group format. |
sitPDF (3) | Adobe Acrobat's Portable Document format. |
sitGIF (4) | CompuServe's Graphics Interchange format. |
sitEPL (5) | EPL2 format. |
sitPNG (6) | PNG image. |
sitZPL (7) | ZPLII format. |
sitPDFVector (8) | PDFVector format. |
sitPDFVectorWithFonts (9) | PDFVectorWithFonts format. |
sitAZPL (10) | AZPL format. |
Valid values for USPS (eVSLabels):
- sitTIF (1)
- sitPDF (3)
Valid values for Endicia:
- sitJPG (2)
- sitPDF (3)
- sitGIF (4)
- sitEPL (5)
- sitPNG (6)
- sitZPL (7)
- sitPDFVector (8)
- sitPDFVectorWithFonts (9)
Valid values for Stamps.com:
- sitJPG (2)
- sitPDF (3)
- sitGIF (4)
- sitEPL (5)
- sitPNG (6)
- sitZPL (7)
- sitAZPL (10)
LicenseNumber Property (USPSShipIntl Class)
Import License number if known, or included in package.
Syntax
public String getLicenseNumber(); public void setLicenseNumber(String licenseNumber);
Default Value
""
Remarks
Many countries require the sender to obtain a license in order to import certain items (for example, drugs or medical equipment). Restrictions as to what items require a license are returned in the Restrictions property.
The value of this property is optional. Maximum length: 24.
This property is not applicable for International First Class mail.
Machinable Property (USPSShipIntl Class)
Indicates if shipment is machinable or not.
Syntax
public int getMachinable(); public void setMachinable(int machinable); Enumerated values: public final static int moTrue = 0; public final static int moFalse = 1; public final static int moIrregular = 2;
Default Value
0
Remarks
The default value for this property is moTrue (0).
Note: The value moIrregular (2) is valid only when ServiceType is stUSPSBPM (74), stUSPSMedia (75), or stUSPSLibrary (76).
Possible values are as follows:
Value | Description |
moTrue (0) | True (default) |
moFalse (1) | False |
moIrregular (2) | Irregular |
MailingLocation Property (USPSShipIntl Class)
Postal Office Zip Code where the item will be mailed (if different from ZipCode ).
Syntax
public String getMailingLocation(); public void setMailingLocation(String mailingLocation);
Default Value
""
Remarks
The value of this property is optional.
If you plan to mail your item(s) from a post office or a collection box other than your return address Zip Code (ZipCode), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the MailingLocation property.
This way, you convey this difference to the USPS Server.
This property is not applicable for International First Class mail.
NonDeliveryOption Property (USPSShipIntl Class)
Indicates what to do with the package in case it is undeliverable.
Syntax
public int getNonDeliveryOption(); public void setNonDeliveryOption(int nonDeliveryOption); Enumerated values: public final static int ndoReturn = 0; public final static int ndoRedirect = 1; public final static int ndoAbandon = 2;
Default Value
0
Remarks
In case the package is undeliverable, the package may be Returned, Redirected, or Abandoned.
Value | Meaning |
ndoReturn (0) | Return - the package will be returned to the sender's address (default). |
ndoRedirect (1) | Redirect - the package will be redirected to the address specified in the following configuration settings:
USPS(eVS Label ): RedirectName, RedirectEmail, RedirectSMS, RedirectAddress, RedirectCity, RedirectState, RedirectZipCode, RedirectZip4 USPS(Stamps.com): AltReturnAddress1, AltReturnAddress2, AltReturnCountry |
ndoAbandon (2) | Abandon - the undeliverable package will be disposed. |
This property is not applicable for International First Class mail (stUSPSFirstClassMailInternational (83) ).
Notes Property (USPSShipIntl Class)
Additional information returned by the USPS Server .
Syntax
public String getNotes();
Default Value
""
Remarks
This property may contain additional notes pertaining to the shipment of goods to the destination country (CountryCode).
This property is read-only.
Observations Property (USPSShipIntl Class)
Additional mailing information based on country of destination.
Syntax
public String getObservations();
Default Value
""
Remarks
Additional information that may be important to the sender. Returned by the USPS Server
This property is read-only.
Packages Property (USPSShipIntl Class)
A collection of packages contained in the shipment.
Syntax
public PackageDetailList getPackages(); public void setPackages(PackageDetailList packages);
Remarks
At least one package must be specified.
This property must be set to a collection of PackageDetail instances, which will contain specific information about a package contained in the shipment. See the PackageDetail type for more information.
For USPS, the PackagingType, Size, and Weight fields are required. Length, Width, Height, and Girth are all conditionally required, and more information may be found in the individual field definitions.
Note: USPS only supports one package per shipment.
This property is not available at design time.
PermitNumber Property (USPSShipIntl Class)
Permit number to print Postage Due labels.
Syntax
public String getPermitNumber(); public void setPermitNumber(String permitNumber);
Default Value
""
Remarks
Sending postage due packages requires a permit with a US Post Office. This property should contain the Permit Number you were issued by that post office.
PostageProvider Property (USPSShipIntl Class)
The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.
Syntax
public int getPostageProvider(); public void setPostageProvider(int postageProvider); Enumerated values: public final static int ppNone = 0; public final static int ppEndicia = 1; public final static int ppStamps = 2;
Default Value
0
Remarks
When set to ppNone, the class will communicate with USPS servers. When set to this value the following properties should also be set.
When set to ppEndicia, the class will communicate with Endicia's servers. When set to this value the following properties should also be set.
For Production
- Set AccountNumber
- Set Password
For Testing
- Set EndiciaTestMode
When set to ppStamps, the class will communicate with Stamps.com's servers. When set to this value the following properties should also be set.
- Set UserId
- Set AccountNumber
- Set Password
- Set Server
PriceOption Property (USPSShipIntl Class)
Indicates pricing that should be returned (i.e. Commercial Base).
Syntax
public int getPriceOption(); public void setPriceOption(int priceOption); Enumerated values: public final static int poRetail = 0; public final static int poCommercialPlus = 1; public final static int poCommercialBase = 2;
Default Value
2
Remarks
The default value for this property is poCommercialBase (2).
Note: When ServiceType is stUSPSPriorityMailCubic (134) the component will send "Commercial Plus" in the request (per USPS eVSLabel specifications).
Note: The value poRetail (0) is valid only when ServiceType is stUSPSPriorityMailInternational (84).
Possible values are as follows:
Value | Description |
poRetail (0) | Retail |
poCommercialPlus (1) | Commercial Plus |
poCommercialBase (2) | Commercial Base (default) |
Prohibitions Property (USPSShipIntl Class)
List of items prohibited from mailing to the destination country.
Syntax
public String getProhibitions();
Default Value
""
Remarks
Articles that are prohibited by the destination country are non-mailable. These prohibitions are based on information furnished by the country concerned.
You may also inquire at the Post Office facility about specific prohibitions as a country may return or seize mail containing articles prohibited within that country, whether or not notice of such prohibitions has been provided to or published by the Postal Service.
This property is read-only.
Proxy Property (USPSShipIntl Class)
This property includes a set of properties related to proxy access.
Syntax
public Proxy getProxy(); public void setProxy(Proxy proxy);
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
RecipientAddress Property (USPSShipIntl Class)
Identifies the recipient's address.
Syntax
public AddressDetail getRecipientAddress(); public void setRecipientAddress(AddressDetail recipientAddress);
Remarks
The RecipientAddress is required to be provided in a ship request.
This must be set to an instance of the AddressDetail type, which will contain recipient's address info. See the AddressDetail type for more information.
RecipientContact Property (USPSShipIntl Class)
Identifies the recipient's contact info.
Syntax
public ContactDetail getRecipientContact(); public void setRecipientContact(ContactDetail recipientContact);
Remarks
The RecipientContact is required to be provided in a ship request.
The RecipientContact must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact recipient. See the ContactDetail type for more information.
RecipientCustomsReference Property (USPSShipIntl Class)
Corresponds to the person's Customs Reference field that appears on the shipping label.
Syntax
public String getRecipientCustomsReference(); public void setRecipientCustomsReference(String recipientCustomsReference);
Default Value
""
Remarks
This field may contain any reference number that the person wishes to use.
Regulations Property (USPSShipIntl Class)
Additional regulations for shipping to the destination country.
Syntax
public String getRegulations();
Default Value
""
Remarks
Any additional regulations not covered under Restrictions, Observations, or Prohibitions will be listed here after a successful transaction. The returned data might include information such as: country code, required Customs Forms, special notes when shipping certain items, areas served, etc.
This property is read-only.
Restrictions Property (USPSShipIntl Class)
Restrictions on items being shipped based on country of destination.
Syntax
public String getRestrictions();
Default Value
""
Remarks
This property will contain information indicating mail articles which are restricted by the destination country, Any packages sent are subject to the import requirements of that country. The contents of this property is based on information furnished by the country concerned.
You may also inquire at the Post Office facility about specific restrictions as a country may return or seize mail containing articles prohibited or restricted within that country, whether or not notice of such restriction has been provided to or published by the Postal Service.
This property is read-only.
SDRValue Property (USPSShipIntl Class)
Special Drawing Right calculated on TotalValue .
Syntax
public String getSDRValue();
Default Value
""
Remarks
The Special Drawing Right (SDR) is an artificial currency unit based on a collection of major world currencies. The SDRValue is the calculated TotalValue in this artificial currency.
This property is read-only.
SenderAddress Property (USPSShipIntl Class)
Identifies the sender's address.
Syntax
public AddressDetail getSenderAddress(); public void setSenderAddress(AddressDetail senderAddress);
Remarks
The SenderAddress is required to be provided in a ship request when the GetPackageLabel method is called.
This must be set to an instance of the AddressDetail type, which will contain shipper's address details. See the AddressDetail type for more information.
SenderContact Property (USPSShipIntl Class)
Identifies the sender's contact info.
Syntax
public ContactDetail getSenderContact(); public void setSenderContact(ContactDetail senderContact);
Remarks
The SenderContact is required to be provided in a ship request, when the GetPackageLabel method is called.
This must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact sender. See the ContactDetail type for more information.
SenderCustomsReference Property (USPSShipIntl Class)
Corresponds to the person's Customs Reference field that appears on the shipping label.
Syntax
public String getSenderCustomsReference(); public void setSenderCustomsReference(String senderCustomsReference);
Default Value
""
Remarks
This field may contain any reference number that the person wishes to use.
ServiceType Property (USPSShipIntl Class)
The mail service type when shipping to the CountryCode .
Syntax
public int getServiceType(); public void setServiceType(int serviceType); Enumerated values: public final static int stUnspecified = 0; public final static int stFedExPriorityOvernight = 10; public final static int stFedExStandardOvernight = 11; public final static int stFedExFirstOvernight = 12; public final static int stFedEx2Day = 13; public final static int stFedExExpressSaver = 14; public final static int stFedExGround = 15; public final static int stFedExGroundHomeDelivery = 16; public final static int stFedEx1DayFreight = 17; public final static int stFedEx2DayFreight = 18; public final static int stFedEx3DayFreight = 19; public final static int stFedExInternationalPriority = 20; public final static int stFedExInternationalEconomy = 21; public final static int stFedExInternationalFirst = 22; public final static int stFedExInternationalPriorityFreight = 23; public final static int stFedExInternationalEconomyFreight = 24; public final static int stFedExEuropeFirstInternationalPriority = 25; public final static int stFedExSmartPost = 26; public final static int stFedEx2DayAM = 27; public final static int stFedExFirstFreight = 28; public final static int stFedExInternationalGround = 29; public final static int stFedExFreightEconomy = 30; public final static int stFedExFreightPriority = 31; public final static int stFedExInternationalPriorityExpress = 32; public final static int stFedExInternationalConnectPlus = 33; public final static int stUPSFirstClass = 35; public final static int stUPSPriorityMail = 36; public final static int stUPSExpeditedMailInnovations = 37; public final static int stUPSPriorityMailInnovations = 38; public final static int stUPSEconomyMailInnovations = 39; public final static int stUPSNextDayAir = 40; public final static int stUPSExpress = 41; public final static int stUPS2ndDayAir = 42; public final static int stUPSGround = 43; public final static int stUPSWorldwideExpress = 44; public final static int stUPSWorldwideExpedited = 45; public final static int stUPSExpedited = 46; public final static int stUPSStandard = 47; public final static int stUPS3DaySelect = 48; public final static int stUPSNextDayAirSaver = 49; public final static int stUPSSaver = 50; public final static int stUPSNextDayAirEarlyAM = 51; public final static int stUPSExpressEarlyAM = 52; public final static int stUPSWorldwideExpressPlus = 53; public final static int stUPSExpressPlus = 54; public final static int stUPS2ndDayAirAM = 55; public final static int stUPSTodayStandard = 56; public final static int stUPSTodayCourrier = 57; public final static int stUPSTodayInterCity = 58; public final static int stUPSTodayExpress = 59; public final static int stUPSTodayExpressSaver = 60; public final static int stUPSWorldwideExpressFreight = 61; public final static int stUPSSurePostLessThan1LB = 62; public final static int stUPSSurePost1LBOrGreater = 63; public final static int stUPSSurePostBPM = 64; public final static int stUPSSurePostMedia = 65; public final static int stUSPSExpress = 70; public final static int stUSPSFirstClass = 71; public final static int stUSPSPriority = 72; public final static int stUSPSParcelPost = 73; public final static int stUSPSBPM = 74; public final static int stUSPSMedia = 75; public final static int stUSPSLibrary = 76; public final static int stUSPSOnline = 77; public final static int stUSPSGlobalExpress = 78; public final static int stUSPSParcelSelect = 79; public final static int stUSPSCriticalMail = 80; public final static int stUSPSStandardMail = 81; public final static int stUSPSExpressMailInternational = 82; public final static int stUSPSFirstClassMailInternational = 83; public final static int stUSPSPriorityMailInternational = 84; public final static int stUSPSPriorityExpress = 85; public final static int stUSPSRetailGround = 86; public final static int stUSPSFirstClassPackageInternationalService = 87; public final static int stUSPSPriorityMailExpressInternational = 88; public final static int stCanadaRegularParcel = 90; public final static int stCanadaExpeditedParcel = 91; public final static int stCanadaXpresspost = 92; public final static int stCanadaLibrary = 93; public final static int stCanadaPriority = 94; public final static int stCanadaPriorityEnvelopeUSA = 95; public final static int stCanadaPriorityPakUSA = 96; public final static int stCanadaPriorityParcelUSA = 97; public final static int stCanadaXpresspostUSA = 98; public final static int stCanadaExpeditedParcelUSA = 99; public final static int stCanadaSmallPacketAirUSA = 100; public final static int stCanadaTrackedPacketUSA = 101; public final static int stCanadaTrackedPacketLVMUSA = 102; public final static int stCanadaPriorityEnvelopeInternational = 103; public final static int stCanadaPriorityPakInternational = 104; public final static int stCanadaPriorityParcelInternational = 105; public final static int stCanadaXpresspostInternational = 106; public final static int stCanadaSmallPacketAirInternational = 107; public final static int stCanadaSmallPacketLandInternational = 108; public final static int stCanadaParcelAirInternational = 109; public final static int stCanadaParcelLandInternational = 110; public final static int stCanadaTrackedPacketInternational = 111; public final static int stFedExDistanceDeferred = 120; public final static int stFedExNextDayAfternoon = 121; public final static int stFedExNextDayEarlyMorning = 122; public final static int stFedExNextDayEndOfDay = 123; public final static int stFedExNextDayFreight = 124; public final static int stFedExNextDayMidMorning = 125; public final static int stFedExSameDay = 126; public final static int stFedExSameDayCity = 127; public final static int stFedExSameDayMetroAfternoon = 128; public final static int stFedExSameDayMetroMorning = 129; public final static int stFedExSameDayMetroRush = 130; public final static int stUPSWorldwideEconomyDDU = 131; public final static int stUPSWorldwideEconomyDDP = 132; public final static int stUSPSParcelSelectGround = 133; public final static int stUSPSPriorityMailCubic = 134;
Default Value
0
Remarks
This property is required to be provided in a ship request when the GetPackageLabel method is called.
Possible values are:
stUSPSExpressMailInternational (82) | |
stUSPSFirstClassMailInternational (83) | |
stUSPSPriorityMailInternational (84) | |
stUSPSFirstClassPackageInternationalService (87) (Endicia only) | |
stUSPSPriorityMailExpressInternational (88) (Endicia only) |
This property is not available at design time.
ShipDate Property (USPSShipIntl Class)
Date package will be mailed.
Syntax
public String getShipDate(); public void setShipDate(String shipDate);
Default Value
""
Remarks
You can post-date the Express Mail label up to three days in advance by using this optional property. The mailing date entered should reflect the actual date the package will be shipped. For USPS, the ship date may be today plus 0 to 3 days in advance. Enter the date in either format: yyyy-MM-dd, such as 2022-08-14, or MM/dd/yyyy, such as 08/14/2022.
This property allows you to post-date the Signature Confirmation label up to four days in advance. The package should not be shipped until the label date requested.
Note: When using Endicia, only the format yyyyMMdd is valid and may be specified up to 7 days in advance. When using Stamps.com date format should be "yyyy-MM-dd", e.g. 2022-08-14.
This property is also returned after the following carrier pickup methods are called:
- PickupAvailability
- SchedulePickup
- ChangePickup
- PickupInquiry
ShipmentSpecialServices Property (USPSShipIntl Class)
Contains the collection of special services offered by USPS on shipment level.
Syntax
public long getShipmentSpecialServices(); public void setShipmentSpecialServices(long shipmentSpecialServices);
Default Value
0
Remarks
To request any of the special services offered by USPS, you must set the ShipmentSpecialServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:
Value | Meaning |
0x0000000000000004L | COD |
0x0000000000008000L | Hold For Pickup |
0x0000000008000000L | Return Shipment |
0x0000000080000000L | Restricted Delivery |
0x0000000100000000L | Return Receipt |
0x0000000200000000L | Certificate Of Mailing |
0x0000000400000000L | Sunday and Holiday Delivery |
0x0000000800000000L | No Weekend |
0x0000001000000000L | Registered Mail |
0x0000002000000000L | Premium Service (Sunday/Holiday) |
0x0000004000000000L | Commercial |
0x0000008000000000L | Delivery Confirmation |
0x0010000000000000L | Electronic Return Receipt |
SSLAcceptServerCert Property (USPSShipIntl Class)
Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
SSLCert Property (USPSShipIntl Class)
The certificate to be used during SSL negotiation.
Syntax
public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert);
Remarks
The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
SSLProvider Property (USPSShipIntl Class)
This specifies the SSL/TLS implementation to use.
Syntax
public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2;
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.
SSLServerCert Property (USPSShipIntl Class)
The server certificate for the last established connection.
Syntax
public Certificate getSSLServerCert();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Timeout Property (USPSShipIntl Class)
A timeout for the class.
Syntax
public int getTimeout(); public void setTimeout(int timeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class throws an exception.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
TotalValue Property (USPSShipIntl Class)
Total value of all items being shipped.
Syntax
public String getTotalValue();
Default Value
""
Remarks
This is the total value of all items in the package. It should match the sum of all individual UnitPrices.
This property is read-only.
TransactionId Property (USPSShipIntl Class)
The transaction Id.
Syntax
public String getTransactionId(); public void setTransactionId(String transactionId);
Default Value
""
Remarks
This property is only used for Endicia labels, and is defined as a unique Id for the partner's end-user's transaction. This can be an invoice number or transaction number.
USPSAccount Property (USPSShipIntl Class)
Login information for USPS.
Syntax
public USPSAccount getUSPSAccount(); public void setUSPSAccount(USPSAccount USPSAccount);
Remarks
This property must be set when connecting to USPS servers. It contains server and login information.
CancelPackage Method (Uspsshipintl Class)
Cancels a single package by deleting it from the eVS shipping log.
Syntax
public String cancelPackage(String barcodeNumber);
Remarks
The Cancel request allows an eVS label to be removed from processing. This functionality is available only if the eVS label is pending inclusion in the Shipping Services.
The BarcodeNumber parameter that identifies the package to be canceled and deleted from the shipping log, is the TrackingNumber assigned to the package by USPS server when the GetPackageLabel method was called.
If the BarcodeNumber entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from USPS about the request to cancel the eVS Label.
Config Method (Uspsshipintl Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String configurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
GetPackageLabel Method (Uspsshipintl Class)
Generates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.
Syntax
public void getPackageLabel();
Remarks
When this method is called, the following properties are used to construct the request:
- UserId (required for API authentication)
- FirstName (required unless Company is provided)
- MiddleInitial (optional)
- LastName (required unless Company is provided)
- Company (optional if FirstName and LastName are provided)
- Phone (required)
- Address1 (required)
- Address2 (optional)
- City (required)
- State (required)
- ZipCode (required)
- SenderUrbanization (optional)
- SenderCustomsReference (optional)
- FirstName (you must send either a name or Company (or both))
- LastName (you must send either a name or Company (or both))
- Company (optional if name is provided)
- Phone (optional)
- Fax (optional)
- Email (optional)
- Address1 (at least one address line is required)
- Address2
- RecipientAddress3
- City (required)
- State (Province, optional)
- CountryCode (required)
- ZipCode (Postal Code, required)
- AddressFlags (required)
- RecipientCustomsReference (optional)
- NonDeliveryOption (if this is set to "REDIRECT" provide the return address via Config)
- RedirectName (optional)
- RedirectEmail (optional)
- RedirectSMS (optional)
- RedirectAddress (optional)
- RedirectCity (optional)
- RedirectState (optional)
- RedirectZipCode (optional)
- RedirectZip4 (optional)
- PackagingType (optional)
- Description (required)
- Quantity (required)
- Value (required)
- Weight (required)
- HarmonizedCode (optional)
- Manufacturer (optional)
- UseInsurance (optional)
- InsurancePolicy (optional)
- InsuredValue (optional)
- NetCharge (optional - if left blank the server will return the postage cost here)
- Weight (required)
- Length (optional)
- Width (optional)
- Height (optional)
- Machinable (optional)
- Contents (required - if set to ctOther OtherContents must be set)
- Comments (optional)
- LicenseNumber (optional)
- CertificateNumber (optional)
- InvoiceNumber (optional)
- LabelImageType (required)
- ImageLayout (optional)
- CustomerId (optional)
- CustomerId2 (optional)
- MailingLocation (optional)
- ShipDate (optional. If specified must be within 3 days)
- HoldForManifest (optional)
- EELPFC (optional)
- PriceOption (optional)
- MeterPayment (optional)
- ExtraServices (optional)
- ActionCode (optional)
- OptOutOfSPE (optional)
- PermitNumber (optional)
- ImportersReferenceType (optional)
- ImportersContact (optional - Phone, Fax, Email)
- DestinationRateIndicator (optional)
- MID (optional)
- LogisticsManagerMID (optional)
- CRID (optional)
- VendorCode (optional)
- VendorProductVersionNumber (optional)
- ShippingLabelFile (optional if you wish to save the labels to disk)
This method fills the following properties:
- TrackingNumber
- BarcodeNumber
- ShippingLabel
- NetCharge
- TotalValue
- SDRValue
- IndemnityCoverage (Priority Mail only)
- Prohibitions
- Observations
- Restrictions
- Regulations
- Notes
If ShippingLabelFile was specified with a path and filename, all of the returned label images will also be saved to disk.
Reset Method (Uspsshipintl Class)
Resets the internal state of the class and all properties to their default values.
Syntax
public void reset();
Remarks
The Reset method does not have any parameters and does not return any value.
Error Event (Uspsshipintl Class)
Information about errors during data delivery.
Syntax
public class DefaultUspsshipintlEventListener implements UspsshipintlEventListener { ... public void error(UspsshipintlErrorEvent e) {} ... } public class UspsshipintlErrorEvent { public int errorCode; public String description; }
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Notification Event (Uspsshipintl Class)
Notification returned by the server upon successful request (if applicable).
Syntax
public class DefaultUspsshipintlEventListener implements UspsshipintlEventListener { ... public void notification(UspsshipintlNotificationEvent e) {} ... } public class UspsshipintlNotificationEvent { public String message; }
Remarks
When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.
Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.
SSLServerAuthentication Event (Uspsshipintl Class)
Fired after the server presents its certificate to the client.
Syntax
public class DefaultUspsshipintlEventListener implements UspsshipintlEventListener { ... public void SSLServerAuthentication(UspsshipintlSSLServerAuthenticationEvent e) {} ... } public class UspsshipintlSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; }
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (Uspsshipintl Class)
Shows the progress of the secure connection.
Syntax
public class DefaultUspsshipintlEventListener implements UspsshipintlEventListener { ... public void SSLStatus(UspsshipintlSSLStatusEvent e) {} ... } public class UspsshipintlSSLStatusEvent { public String message; }
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
AddressDetail Type
Represents the address details of a sender or recipient.
Remarks
This type contains descriptive data of physical location of a sender or recipient.
Example: Setting the fields of a sender
SenderAddress addr = new SenderAddress
addr.Address1 = "100 Somewhere St."
addr.Address2 = "Ste 100"
addr.City = "Raleigh"
addr.State = "NC"
addr.ZipCode = "27154"
addr.CountryCode = "US"
The fields contained by this type are listed below.
Fields
Address1 String |
Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS Address1 should not exceed 35 characters. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Address2 String |
A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS Address2 should not exceed 35 characters. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddressFlags int |
Various flags that denote information about the address.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
City String |
Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CountryCode String |
Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2. Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.
* Not supported by USPS ** Has multiple values, the values used for USPS are below
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
State String |
State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ZipCode String |
Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both City and State are not present. Valid characters: A-Z; 0-9; a-z. Maximum length: 16. |
Constructors
public AddressDetail();
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate String |
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. |
||||||||||||||||||||||||||||||||||||||||||||||||
Encoded String |
This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate. When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
EncodedB byte[] |
This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate. When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
ExpirationDate String |
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. |
||||||||||||||||||||||||||||||||||||||||||||||||
ExtendedKeyUsage String |
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). |
||||||||||||||||||||||||||||||||||||||||||||||||
Fingerprint String |
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02 |
||||||||||||||||||||||||||||||||||||||||||||||||
FingerprintSHA1 String |
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84 |
||||||||||||||||||||||||||||||||||||||||||||||||
FingerprintSHA256 String |
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53 |
||||||||||||||||||||||||||||||||||||||||||||||||
Issuer String |
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
KeyPassword String |
This is the password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys. Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey. |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKey String |
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyAvailable boolean |
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication). |
||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyContainer String |
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKey String |
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKeyAlgorithm String |
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. |
||||||||||||||||||||||||||||||||||||||||||||||||
PublicKeyLength int |
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. |
||||||||||||||||||||||||||||||||||||||||||||||||
SerialNumber String |
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. |
||||||||||||||||||||||||||||||||||||||||||||||||
SignatureAlgorithm String |
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. |
||||||||||||||||||||||||||||||||||||||||||||||||
Store String |
This is the name of the certificate store for the client certificate. The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store). |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreB byte[] |
This is the name of the certificate store for the client certificate. The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store). |
||||||||||||||||||||||||||||||||||||||||||||||||
StorePassword String |
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
||||||||||||||||||||||||||||||||||||||||||||||||
StoreType int |
This is the type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This field can take one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
Subject String |
This is the subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
If a field value contains a comma it must be quoted. |
||||||||||||||||||||||||||||||||||||||||||||||||
SubjectAltNames String |
This field contains comma-separated lists of alternative subject names for the certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintMD5 String |
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintSHA1 String |
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. |
||||||||||||||||||||||||||||||||||||||||||||||||
ThumbprintSHA256 String |
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. |
||||||||||||||||||||||||||||||||||||||||||||||||
Usage String |
This field contains the text description of UsageFlags. This value will be of one or more of the following strings and will be separated by commas:
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. |
||||||||||||||||||||||||||||||||||||||||||||||||
UsageFlags int |
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
Please see the Usage field for a text representation of UsageFlags. This functionality currently is not available when the provider is OpenSSL. |
||||||||||||||||||||||||||||||||||||||||||||||||
Version String |
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3". |
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate( certificateFile);
Opens CertificateFile and reads out the contents as an X509 public key.
public Certificate( certificateData);
Parses CertificateData as an X509 public key.
public Certificate( certStoreType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
public Certificate( certStoreType, storeBlob, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate( certStoreType, storeBlob, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
CommodityDetail Type
Represents a single commodity line item.
Remarks
This type contains specific information about a commodity line item included in the shipment. It is used in the international shipping components when either the GetPackageLabel or GetShipmentLabels method is called. For UPS, it is applicable if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.
Example: Setting the fields for a commodity line item
CommodityDetail commodity = new CommodityDetail();
commodity.Description = "Computer software"
commodity.Manufacturer = "US"
commodity.Weight = "1.0"
commodity.QuantityUnit = "EA"
commodity.UnitPrice = "99.99"
commodity.HarmonizedCode = "9031.80.90"
Note: The following fields are applicable to UPS Freight services.
field | Required? |
Description | Yes |
FreightClass | Conditional, required only for ground shipments |
FreightIsHazardous | Conditional, required if hazardous materials are contained in the shipment |
FreightNMFC | No |
FreightNMFCSub | Conditional, required if FreightNMFC is specified |
FreightPackagingType | Yes |
NumberOfPieces | Yes |
Value | Yes |
Weight | Yes |
The fields contained by this type are listed below.
Fields
Description String |
Complete and accurate description of this commodity line item. It is applicable to all international forms. Optional for Partial Invoice and required for the rest of form types. Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label. For FedEx, if the shipment contains documents only (i.e., Documents is set to True), then the Description has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExportType int |
Indicates the export type. Applicable and required for SED only. Valid values are:
NOTE: This field is only applicable to UPS shipments. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FreightClass String |
Indicates the freight class of the commodity. The following table lists freight classes available from UPS freight services.
NOTE: This field is only applicable to UPS freight. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FreightIsHazardous boolean |
Identifies if the Commodity item is hazardous. NOTE: This field is only applicable to UPS freight. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FreightNMFC String |
Identifies the National Motor Freight Classification numbers. NOTE: This field is only applicable to UPS freight. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FreightNMFCSub String |
Identifies the sub code of National Motor Freight Classification numbers. NOTE: This field is only applicable to UPS freight. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FreightPackagingType int |
Identifies the Commodity item's packaging type. Possible values are:
NOTE: This field is only applicable to UPS freight. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HarmonizedCode String |
Unique code representing this commodity line item (for imports only). The World Trade Organization has classified all commodities with a number. This number is called a Harmonized Schedule code and ranges from six to 12 digits depending on the country. However, the first six digits of this number are more or less uniform throughout the world. Customs uses the HS number to determine the import duties, taxes and import license requirements for goods entering a country. This number is required for filling in the Customs documentation. It is applicable to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. For NAFTA CO: For each good described in Description, identify the Harmonized Schedule (HS) tariff classification using the one of the country into whose territory the good is imported. This number must appear on import documentation that accompanies a shipment. If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the HarmonizedCode is required for each commodity line item for shipments to EU countries. At least one occurrence is required for U.S. Export shipments if the TotalCustomsValue is greater than 2,500 USD or if a valid U.S. Export license is required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Manufacturer String |
Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the Manufacturer is required to be entered. In FedEx, when the shipment contains documents only (i.e., Documents is set to True), this represent the country where the documents were compiled and/or produced in their final form. In this case, only the Manufacturer and Description are required to be provided in the request. If the Manufacturer is not provided, it defaults to US. When the shipment contains non-documents items (i.e., Documents is set to False and the shipment is considered dutiable), at least one occurrence of a commodity item is required to be entered. The Manufacturer has to be provided for each commodity item included in that international shipment. In UPS, this applies to Invoice, Partial Invoice, CO and NAFTA CO. It is required for Invoice and CO forms, and optional for Partial Invoice. In USPS, the value of this property is optional, and is only used by commercial shippers. If PostageProvider is set to ppEndicia or ppStamps, then the format must be 2 charachters long (for example: US for United States, CA for Canada etc.). For FedEx and UPS, XX may be used to indicate multiple countries of manufacturer. Here is a list of country names and their codes where UPS services are available. Code is the value that has to be provided in all requests sent to UPS where country code is to be entered. This is also echoed in server reply. Along with country names and their codes, we have also listed here the currency code used in that country, the maximum weight applicable to that country, whether address validation is supported and if postal code is required.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NumberOfPieces int |
The total number of packages, cartons, or containers for the commodity line item. In UPS, it is required and applicable to CO only. In FedEx, if the Documents is set to False in ship request, the NumberOfPieces is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments. This field is not applicable to USPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageNumber String |
The package number that this commodity is in. Only applicable when requesting international forms with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Quantity int |
Number of units contained in this commodity line item measured in units specified by the QuantityUnit. This is used in conjunction with the QuantityUnit and UnitPrice. For FedEx, if the Documents is set to False in ship request, the Quantity is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments. For UPS, these are all required for Invoice form type and optional for Partial Invoice (not applicable to other international form types). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QuantityUnit String |
Unit of measure used to express the Quantity of this commodity line item. For FedEx, if the shipment contains non-documents item(s) (i.e., the Documents is set to False), the QuantityUnit is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments. Here is a list of possible values for FedEx:
For UPS, this is required and applicable only to Invoice and Partial Invoice forms. Here is a list of possible values for QuantityUnit:
This is not available for USPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ScheduleBCode String |
A unique 10-digit commodity classification code for the item being exported. Before you can export a product from the United States, you must first determine its correct 10-digit Schedule B Classification Code. These codes are valid for only U.S. exports and are maintained by the U.S. Census Bureau. This is required to be provided in an international ship request only if SED is requested (i.e., one of the FormTypes is set to ftSED). This field is only applicable to UPS shipments. Current format: 10 digits. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UnitPrice String |
Value of each QuantityUnit in Quantity of this commodity line item. This is used in conjunction with the QuantityUnit and Quantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero. For FedEx, when the shipment contains non-documents item(s) (i.e., the Documents is set to False), the UnitPrice is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments. For UPS, it is required and applicable to Invoice and Partial Invoice forms only. For USPS, use the Value field instead. Format: Limit to 6 digits after the decimal (e.g. 900.000000). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Value String |
The value of an individual item being shipped. This should be provided for each item contained in the package being shipped. This property provides the value of the set of items. If the item is 2 boxes of 50 pens and the value of each box is $10.00, "20.00" (2 boxes x $10.00) should be entered. If the value of each pen is .25, then "25.00" (100 pens x .25) should be entered. This field is only applicable to USPS and UPS freight. Note: For USPS, the maximum value for this property is "99999.99". Note: For UPS freight, the maximum value for this property is "99999999999999.99". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Weight String |
The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. This weight does not include carrier equipment. For FedEx, if the shipment contains non-documents item(s) (i.e., the Documents is set to False), the Weight is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments. For UPS, this is required and applicable to CO and SED forms only . When using USPS and PostageProvider is set to ppNone, the format of this field must be "XX lbs YY oz", where XX is the number of pounds and YY is the number of ounces. However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting). |
Constructors
public CommodityDetail();
public CommodityDetail( description, manufacturer, harmonizedCode, scheduleBCode, weight, quantity, quantityUnit, unitPrice, numberOfPieces, exportType);
public CommodityDetail( description, manufacturer, harmonizedCode, scheduleBCode, weight, quantity, quantityUnit, unitPrice, numberOfPieces);
public CommodityDetail( description, manufacturer, harmonizedCode, scheduleBCode, weight, quantity, quantityUnit, unitPrice);
public CommodityDetail( description, manufacturer, harmonizedCode, scheduleBCode, quantity, quantityUnit, unitPrice);
public CommodityDetail( description, manufacturer, harmonizedCode, quantity, quantityUnit, unitPrice);
public CommodityDetail( description, manufacturer, weight);
ContactDetail Type
Represents the contact information.
Remarks
This type contains descriptive data identifying the point-of-contact person (such as sender, recipient, broker, etc.).
Example: Setting the fields of the sender
ContactDetail senderContact = new ContactDetail
senderContact.Company = "Anything Anywhere"
senderContact.FirstName = "John"
senderContact.LastName = "Doe"
senderContact.Phone = "1234567890"
senderContact.Email = "test@test.com"
The fields contained by this type are listed below.
Fields
Company String |
Identifies the contact person's company name. In a ship request, either FirstName and LastName or Company are required to be provided. |
Email String |
Identifies the contact person's email address. Maximum length: 120. |
Fax String |
Recipient's fax number. The value of this field is optional. No format checking is done on international fax numbers. |
FirstName String |
Sender's first name. The value of this property is required. Values for either FirstName and LastName or Company must be sent. |
LastName String |
Person's last name. The value of this field is required. Values for either FirstName and LastName or Company must be sent. Maximum length: 45 characters for both names or company name. |
MiddleInitial String |
Middle initial. The value of this field is optional. |
Phone String |
Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15. |
Constructors
public ContactDetail();
public ContactDetail( firstName, lastName, phone);
public ContactDetail( firstName, lastName, phone, email);
public ContactDetail( firstName, lastName, phone, email, company);
Firewall Type
This is the firewall the class will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect boolean |
This field tells the class whether or not to automatically detect and use firewall system settings, if available. Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified. If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems). |
||||||||||
FirewallType int |
This field determines the type of firewall to connect through. The applicable values are as follows:
|
||||||||||
Host String |
This field contains the name or IP address of firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting. If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception. |
||||||||||
Password String |
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. |
||||||||||
Port int |
This field contains the transmission control protocol (TCP) port for the firewall Host. See the description of the Host field for details. Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details. |
||||||||||
User String |
This field contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this field and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception. |
Constructors
public Firewall();
PackageDetail Type
Represents a single package contained in shipment.
Remarks
This type contains specific information on the package that is part of the whole shipment.
Example: Setting the package elements
PackageDetail pckg = new PackageDetail
pckg.Weight = "2.0"
pckg.Description = "Your order for the 4D Shipping SDK"
pckg.ShippingLabelFile = "shipping label for package# 1.pdf"
The fields contained by this type are listed below.
Fields
BaseCharge String |
Base charge applicable to this package. For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments. In MPS domestic shipments, the rating information is available on the package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package. While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment. For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater. This is not applicable to USPS. For Canada Post, upon a successful response, this is returned in the server reply for the package requested. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODAmount String |
The COD monetary value for the package. For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service. Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in CODLabel). On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead. For UPS, if the CODAmount is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the CODType. COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackagingType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by SignatureType) and COD cannot coexist on a single package. This field is not applicable to USPS packages. Format: Two explicit decimal positions (e.g. 100.00). This is not applicable for Canada Post. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODFile String |
Filename and location to save the CODLabel of this package to. This is applicable for package(s) that use the COD service. When the CODFile is set to a valid path and filename, the contents of the CODLabel are written to disk when either the GetPackageLabel or GetShipmentLabels method is called. This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then CODFile has to have .pdf extension). If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True). This field is only applicable to FedEx shipments. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODLabel String |
Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request. This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the CODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format. Since MPS Ground packages do not travel together and may be delivered at different times, a CODLabel return label will be generated for each package that uses COD service. On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS. This field is only applicable to FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODLabelB byte[] |
Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request. This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the CODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format. Since MPS Ground packages do not travel together and may be delivered at different times, a CODLabel return label will be generated for each package that uses COD service. On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS. This field is only applicable to FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CODType int |
The code that indicates the type of funds that will be used for the COD payment for this package. This field is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., CODAmount is set to a value other than "0.00"). Valid values are:
Note: COD special service is not valid for return service movements. Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DangerousGoodsAccessible boolean |
Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery. This field is only applicable to FedEx shipments, and is required to be specified when the SpecialServices contains the corresponding flag for Dangerous Goods. There are two types of dangerous goods:
Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates class by requesting rates for all available services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DangerousGoodsOptions int |
Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:
Note: This is only valid when using FedEx. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description String |
For FedEx, this is the description that appears in the email to identify this package. This is optional. For UPS, this is applicable and required for shipments with return service only. This does not apply for USPS and Canada Post. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Girth int |
Measurement around the widest part of the package, perpendicular to the Length. This field is only applicable when requesting rates for USPS packages. Note: For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. It is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Height int |
The height of the package to be shipped. For FedEx, the Height is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Width are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment. For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted. Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well. For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge. Note also that this applies to Endicia shipping label requests. For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Id String |
An 8-digit Unique Parcel Identification Number. Unique number used to identify the package. This field is optional, and only applies to USPS return labels. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InsuredValue String |
Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Length int |
The length of the package to be shipped. For FedEx, the Length is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Width and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment. For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container. It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted. Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well. Valid values are 0 to 108 IN and 0 to 270 CM. For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). Note: For parcels, the Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge. Note also that this applies to Endicia shipping label requests. For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NetCharge String |
Net charge applicable to this package. For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl classs only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments. In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package. While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment. For UPS, upon a successful response to GetRates, this is returned in the server reply for each package included in the shipment. For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response. This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package. For Canada Post, upon a successful response, this is returned in the server reply for the package requested. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackagingType int |
The packaging type of the package being rated and/or shipped. Possible values are:
If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0), except for with FedEx, in which case it will default to ptLetter (2). For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagingType for the first package is used in label requests. If the PackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: Length, Width, and Height. If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagingType will be automatically set to 31 (Your Packaging). Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States. For UPS, please note that when selecting PackagingType make sure this is valid for all the following: CountryCode, CountryCode, ServiceType, and all special services requested at both shipment and package level. Also the following restrictions apply when using UPS Mail Innovations:
For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular. For Canada Post, ptLetter (2) is only applicable if theContractId is set. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RatingAggregate String |
Rating aggregate applicable to this package. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference String |
Indicates the package reference type and value, that associates this package (assigned by the customer). For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request. Valid values for types are:
The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the Reference should be set to: CN:123456; IN:123; SN:12;. Reference information may also be used to track packages by reference. For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR. You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request. Valid values for types are:
The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this package, the Reference should be set to: 'AJ:123456; TN:123'. You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True. Reference information may also be used to track packages by reference. For USPS, this is only used by Endicia labels, and is used as a reference value for logs. This is used in Canada Post to provide user-defined values, such as an internal "orderID". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnReceipt String |
Image of the receipt for a return shipment. This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the ReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnReceiptB byte[] |
Image of the receipt for a return shipment. This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the ReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnReceiptFile String |
Filename and location to save the ReturnReceipt of this package to. This is applicable only if using UPS. When the ReturnReceiptFile is set to a valid path and filename, the contents of the ReturnReceipt are written to disk upon successful response (if a return shipment). The ReturnReceiptFile has to have .html extension. Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabel String |
Image of the shipping label for this package returned by the Server upon a successful ship response. This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelB byte[] |
Image of the shipping label for this package returned by the Server upon a successful ship response. This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelFile String |
Filename and location to save the ShippingLabel of this package to. When the ShippingLabelFile is set to a valid path and filename, the contents of the ShippingLabel are written to disk upon successful response. This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then ShippingLabelFile has to have .gif extension). If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelPart2 String |
Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS. This is the decoded binary image file of the part 2* of the shipping label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the part 2* of the label is also saved to disk in a LabelImageType format. For instance, if the ShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif". Note: *Mail Innovations (MI) shipments with more than 3 commodities will receive a 2 page combination label. Part 1 of the label can be accessed via ShippingLabel field whereas Part 2 can be accessed via ShippingLabelPart2 field. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelPart2B byte[] |
Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS. This is the decoded binary image file of the part 2* of the shipping label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the part 2* of the label is also saved to disk in a LabelImageType format. For instance, if the ShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif". Note: *Mail Innovations (MI) shipments with more than 3 commodities will receive a 2 page combination label. Part 1 of the label can be accessed via ShippingLabel field whereas Part 2 can be accessed via ShippingLabelPart2 field. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SignatureType int |
Specifies one of the Delivery Signature Options requested for this package. Possible values are:
For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods. For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct. The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:
Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment. For UPS, when delivery confirmation is requested for a package, the SignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages. Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation. Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option. For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements. This does not apply for Canada Post. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Size int |
Size of the package being mailed. This field is only used by USPS and is required for the GetRates method call. See below for valid entries:
Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note: Use the Length, Height, Width and optionally Girth (irregular shaped packages only) fields to specify the dimensions of the package. Note: only psRegular and psLarge are available when getting rates for international shipments. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SpecialServices long |
Contains the collection of special services offered on the package level. Valid values are:
For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the SpecialServices of that package to a set of valid flags. The meaning and limitations for each special service option are listed below for FedEx:
For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the SpecialServices of that package to a set of valid flags. The meaning and limitations for each special service option are listed below:
Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the CODAmount and CODType, SignatureType, and InsuredValue. This field is not applicable to USPS or Canada Post. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TotalDiscount String |
Total discount applicable to this package. This is specific to the FedEx AccountNumber. It is used in the FedExShip and FedExShipIntl classs only. Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments. In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package. While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TotalSurcharges String |
Total surcharges applicable to this package. For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl classs only. Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments. In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package. While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment. For UPS, upon a successful response, this is returned in the server reply for each package included in the shipment. This does not apply to USPS packages. For Canada Post, upon a successful response, this is returned in the server reply for the package requested. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TrackingNumber String |
Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Weight String |
Weight of this package. For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting). For UPS, this is required to be provided in the request for each package contained in the shipment if PackagingType is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting). Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagingType ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set. For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country. The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104". However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting). For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Width int |
The width of the package to be shipped. For FedEx, the Width is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment. For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted. Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well. For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). Note: For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate. Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge. Note also that this applies to Endicia shipping label requests. For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern). |
Constructors
public PackageDetail();
public PackageDetail( packagingType, weight);
public PackageDetail( length, width, height);
public PackageDetail( packagingType, length, width, height);
public PackageDetail( packagingType, weight, length, width, height);
public PackageDetail( packagingType, weight, length, width, height, specialServices, insuredValue, CODAmount, CODType, signatureType);
public PackageDetail( weight, length, width, height, specialServices, insuredValue, CODAmount, dangerousGoodsAccessible, signatureType);
public PackageDetail( weight, length, width, height, description, reference, specialServices, insuredValue, CODAmount, dangerousGoodsAccessible, signatureType, shippingLabelFile, CODFile);
public PackageDetail( packagingType, weight, length, width, height, description, reference, specialServices, insuredValue, CODAmount, CODType, signatureType, shippingLabelFile, returnReceiptFile);
Proxy Type
This is the proxy the class will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme int |
This field is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set. AuthScheme should be set to authNone (3) when no authentication is expected. By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead. If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If AuthScheme is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this field will clear the values of User and Password. |
||||||||
AutoDetect boolean |
This field tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false. Note: This setting is applicable only in Windows. |
||||||||
Password String |
This field contains a password if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password]. If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
||||||||
Port int |
This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details. |
||||||||
Server String |
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned. |
||||||||
SSL int |
This field determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
|
||||||||
User String |
This field contains a user name, if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password]. If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
Constructors
public Proxy();
public Proxy( server, port);
public Proxy( server, port, user, password);
USPSAccount Type
Represents the details of a USPS account.
Remarks
This type contains data describing the USPS server and login information.
Example: Setting the fields of an account
USPSAccount account = new USPSAccount
account.Server = "https://secure.shippingapis.com/ShippingAPI.dll";
account.Password = "my_password";
account.UserId = "my_username";
The fields contained by this type are listed below.
Fields
AccountNumber String |
The shipper's Endicia account number. This field is only used when shipping with Endicia and will take a production account number. During testing please set EndiciaTestMode which will automatically use a sandbox account. During testing this property does not need to be set. |
||||||||
Password String |
Password to use for logging in to the USPS Server. This password is provided to you by USPS when you register for service. The password is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. Note, the Password property has been depreciated by USPS, and remains only for backwards compatibility. When PostageProvider has been set to ppEndicia, this must be the pass phrase associated with your postage account that was supplied to you by Endicia upon registration. |
||||||||
Server String |
URL for the USPS server where the requests are sent. When PostageProvider has been set to ppEndicia, the live production URL will be set automatically. For testing please set EndiciaTestMode. When PostageProvider has been set to ppStamps, the live production URL will be set automatically. For testing please set StampsTestMode. There are two different live and test URLs that have been provided by the US Postal service for use with the Webtools APIs (and these classs). There is one plaintext URL and one SSL-secured URL for both live and testing. These URLs are listed below, along with the classs that use them. Live Servers:
Test Servers:
These test servers return CANNED RESPONSES. They will only accept a specific set of data, and will only return one pre-formed response. Any transaction that does not contain the exact data they expect will cause an error to be generated. Because of these limitations we strongly recommend you test using a live account. Note that the label components must use the live server for testing, but with the Certify configuration setting set to True. There is no need to set Certify with Endicia or Stamps.com. Set EndiciaTestMode or StampsTestMode instead. |
||||||||
UserId String |
User Id for logging in to the USPS WebTools or Stamps.com Server. This User Id is provided to you by USPS or Stamps.com when you register for service. The UserId is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. During testing set StampsTestMode to use the built-in sandbox account. This field is not used by Endicia. |
Constructors
public USPSAccount();
Config Settings (Uspsshipintl Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.USPSShipIntl Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ActionCode:
Use to specify the Action Code.Use this config setting to specify the Action Code. The Value is included in the Shipping Partner Event file
for customers who have chosen to have a Shipping Partner Event file submitted to USPS on their behalf.
Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnAggregate[i]:
Indicates the AddOn raw XML.This configuration setting returns the raw xml of an AddOn in the list of available AddOns returned.
Valid index values are from 0 to AddOnCount - 1. Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnAmount[i]:
Indicates the AddOn amount.This configuration setting indicates the amount of an AddOn in the list of available AddOns returned.
Valid index values are from 0 to AddOnCount - 1. Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnCount:
Total number of AddOns.This configuration setting returns the total AddOn elements for each service.
Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnType[i]:
Indicates the AddOn type.This configuration setting indicates the AddOn type in the list of available AddOns returned.
Valid index values are from 0 to AddOnCount - 1. Note: This configuration setting is valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnTypeDescription[i]:
Indicates the AddOn description.This configuration setting indicates the textual description of an AddOn in the list of available AddOns returned.
Valid index values are from 0 to AddOnCount - 1. Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddOnTypes:
The AddOn type to be requested.This configuration setting is used to request specific AddOns.
This setting accepts multiple, comma separated, AddOns. For example:
Note: This configuration setting is read-only and valid only for Stamps.com. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AltReturnAddress1: Alternate return address 1.Alternate Return Address Line 1. Valid only with the REDIRECT option (NonDeliveryOption set to "REDIRECT"). Six address lines are provided, but only 1 is required. Use as many as needed for a complete address. Maximum length: 30. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AltReturnAddress2: Alternate return address 2.Alternate Return Address Line 2. Valid only with the REDIRECT option (NonDeliveryOption set to "REDIRECT"). Six address lines are provided, but only 1 is required. Use as many as needed for complete address. Maximum length: 30. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AltReturnCountry: Alternate return country.Alternate Return Country. Valid only with the REDIRECT option (NonDeliveryOption set to "REDIRECT"). Maximum length: 30. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
APOFPOServiceType:
APO/FPO Service Type for Military Mail and US territories (Except Puerto Rico and US Virgin Islands which are considered domestic).Use this configuration setting to set a custom Service Type when shipping to Military Mail and US territories. If RecipientAPOFPOZip is set and the package weight is less than 13 ounces the default Service Type is stUSPSFirstClass. If package weight is more than 13 ounces the Service Type will switch to stUSPSPriority.
Valid values for USPS are:
Default Value: -1 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Certify: Certify/Test mode for label components.If True a Certify request is sent instead of a regular production request. In this manner test labels may be created on a live Server. The default value for this setting is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CommercialPrice:
Indicates whether the commercial price should be returned.When set to true, the commercial price will be returned.
This is required to be true when using the PackagingType ptRegionalRateBoxA or ptRegionalRateBoxB |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CommodityItemCode[i]:
Item code representing the commodity line item.Item code representing the commodity line item. This configuration setting is required for DHL Global Mail.
Valid index values are from 0 to CommoditiesCount - 1. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CRID: Customer Registration ID.The Customer Registration ID (CRID) is provided to you by USPS. It is a unique number that identifies a specific location involved in a mailing. Customers must have a CRID in order to submit electronic documenation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CustomerId2:
User-assigned number for internal use. Corresponds to the CustomerRefNo2 tag of the eVS label API.You can set a value to CustomerId2 config setting as well as CustomerId property if you have a
need to cross-reference information about a shipment using your own tracking or inventory systems. Any
combination of alpha and numeric characters can be entered, up to a maximum of 30.
Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId2 value on the shipping label image if you set the PrintCustomerRefNo2 to True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CustomsFormType:
The customs form type of the label.This configuration is only valid when PostageProvider has been set to ppEndicia. The default value for this
setting is "1"
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CustomsSigner:
The name of the person certifying the customs information is correct.This config should contain the name of the person who is certifying that the information conatined in the customs form
is accurate.
Note this config only applies when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DeclaredValue:
The amount to declare.This configuration setting is used to declare the amount of the shipment. This setting is required by Stamps.com for all international shipments.
Note: This configuration setting is valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DestinationRateIndicator:
Destination rate indicator for eVS International labels.Use this config setting to specify the Destination Rate Indicator which is required for destination
entry packages. Default value is "N" (None).
Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EELPFC:
Exemption and Exclusion Legend or PFC Code.Use this configuration setting to indicate the Exemption and Exclusion Legend (EEL) or Proof of Filing Citation (PFC). For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaHazMatDescription:
HazMat Description.This specifies the dangerous goods categories.
The valid values are as follows:
This is only valid when using Endicia's DHL consolidator services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaHazMatPhone:
HazMat phone number.This specifies the HazMat phone number.
This is only valid when using Endicia's DHL consolidator services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaInsuranceType:
The Insurance type when using Endicia.This will determine which type of insurance will be used when requesting a label through Endicia.
Note that if this is set to None, and an insurance amount is provided, Endicia Insurance will be used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaPrintConsolidatorLabel:
Used to request Consolidator Services.When set to True, Endicia Label Server will generate USPS workshare labels for consolidators that partner with Endicia. The default value is false.
Note that your Endicia account must be first activated for Consolidator Services. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaTestMode:
Controls whether requests are test requests or live requests.When set to a non-zero value the class will use a built-in sandbox account and set the TEST flag to "Yes" in the request itself. For all values this will automatically set Server as defined below.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EndiciaValidateAddress:
Defines if the address should be validated or not.If True (default value) the SenderAddress and the RecipientAddress are validated. Set it to False if you wish to bypass the address validation.
This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EntryFacility:
Postal facility where mail is entered.This specifies the postal facility where the mail is to be entered. If this is not set to Other and the postal
facility's zip code is different than your return address zip code (ZipCode), then you must specify
a zip code in MailingLocation
The valid values are as follows:
This is required when the ServiceType is set to either stParcelSelect or stStandardMail. Also, this is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EscapeEndiciaXML:
Whether to escape XML special characters when using Endicia.When set to true, XML special characters will automatically be escaped when using Endicia. Default is false.
This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HasXPath: Determines whether a specific element exists in the document.This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath. This method returns True if the XPath exists, False if not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HoldForManifest: Holds manifest record for inclusion in SCAN request.This feature is restricted to authorized users only. When True, it indicates that the manifest record should be held for possible inclusion in the SCAN request. Default is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ImageParameters: For future use.Setting a value to this configuration setting will fill the <ImageParameters> tag in a label request. The USPS does not support this functionality at this time. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ImportersReferenceType:
Importer's Reference Type for eVS International labels.Use this config setting to specify the Importer's Reference Type. The Importer's Reference might be a tax code,
VAT number, or importer code used for sales tax.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncludePostage:
Used to determine if the postage will be printed on the label.When set to true (default), the postage will be included on the label. Otherwise no postage will be printed on the label.
Note that when true, Stealth is also set to true so that the postage price will not be printed on the label. This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IntegratorTxId:
Stamps.com transaction integrator Id.Every time GetPackageLabel method is called a unique IntegratorTxId is generated. In case GetPackageLabel method fails for some reason, this configuration setting can be used to repeat the call. Stamps.com checks if the IntegratorTxId has been used before. If it has been used, the service will treat the call as a replay and simply return the response of the initial call.
Note: This setting is valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LabelImageResolution:
The resolution of the label.This configuration is only valid when PostageProvider has been set to ppEndicia. The resolution for the image
defaults to 300 DPI for domestic and international labels. For labels with the LabelImageType set to sitEPL
or sitZPL, the image resolution must be set to 203. The following values are valid:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LabelImageRotation:
The rotation of the label.This configuration is only valid when PostageProvider has been set to ppEndicia. When LabelImageType has been
set to sitEPL or sitZPL, setting this configuration to 2 will print from the top of the image buffer.
Selecting 0 will print from the bottom of the image buffer. Rotating 90 and 270 degrees are not valid for sitEPL
or sitZPL image types. The following values are valid:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LabelSize:
The size of the label.This configuration is only valid when PostageProvider has been set to ppEndicia or ppStamps. Set this to
one of the following values to change the size of the label that is returned by the server.
Valid Values for Endicia:
Valid values for Stamps.com
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogisticsManagerMID:
Logistics Manager Mailer ID.The Logistics Manager Mailer ID is the MID of the company that manages the mailing and it's assigned by USPS.
Note that if LogisticsManagerMID is populated, either CRID or MID must also be populated. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Memo: Customer defined data to be printed on a Stamps shipping label.This config is used to add a user-defined text (memo) to print at the bottom of the Stamps shipping label. The maximum number of characters is 150. For a single line memo, it will print in a single box. For a multi-line memo, the first two lines will be put into the two separate boxes of the label. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MeterPayment:
Meter payment indicator.When set to true indicates Meter Payment. The default value is false.
Note that this only applies when ServiceType is stUSPSExpressMailInternational (82). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MID: Mailer ID.The Mailer Identifier (MID) is provided to you by USPS. MID is a field within the Intelligent Mail barcode that is used to identify mailers. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OptOutOfSPE: Opt out of Shipping Partner Event file creation.When True (default) allows a customer to opt out of SPE (Shipping Partner Event) file creation. Setting it to False will create a SPE file. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OtherContents:
Description of the contents.If Contents is set to ctOther, you may be required to set this configuration setting with a description
of the contents. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Overwrite: Determines whether label files will be overwritten.If True (default value) the label files are overwritten. Otherwise, an error is returned if the file exist. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageLabelUrl:
Stams.com label Url.This configuration setting is populated by Stamps.com after calling GetPackageLabel when LabelImageType is set to sitNone
Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageShippingLabelCount[i]:
Total number of labels and / or custom forms returned in the response for each package.This configuration setting returns the Total number of labels and / or custom forms returned in the response for each package.
Note: This configuration setting is read-only. Valid index values are from 0 to PackageCount - 1. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageShippingLabelIndex[i]:
Image of the shipping label return by the Server upon a successful ship response for each package.This configuration setting returns the Total number of labels and / or custom forms returned in the response.
Valid index values are from 0 to PackageShippingLabelCount[i]; - 1. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POZipCode:
ZIP Code of Post Office.This configuration setting is Required when EntryFacility is not set to Other. The value of this element must contain the ZIP Code of the postal facility specified in EntryFacility.
This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RawRequest: Contains the complete request sent to the Server.This returns the complete request as sent to the server. Used for debugging purposes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RawResponse: Contains the complete response returned by the Server.This returns the complete response as received from the server. Used for debugging purposes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RecipientAddress3:
Recipient's address line 3.Four address lines are provided: Address1 Address2 RecipientAddress3
and RecipientAddress4, but only Address1 is required. Unlike the address fields for other
classs, there are no restrictions as to what information can appear on each line. Use as many as needed for complete address.
Maximum length: 48. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RecipientAddress4:
Recipient's address line 4.Four address lines are provided with shipping address, but only 1 is required. Use as many as needed for complete address.
Maximum Length: 48. This is only used by customs forms. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RecipientAPOFPOZip:
APO/FPO ZIP code for Military Mail.Use this configuration if the recipient address is an APO or FPO address entering the recipient APO/FPO ZIP code.
Either a country name or an APO/FPO ZIP code value must be provided. Both values may not be provided.
Military addresses must show the grade, full name with middle name or initial, and PSC number, unit number, or ship name. In this case, replace the city name with "APO " or "FPO," and the state with "AA," "AE," or "AP,". Use the Address1, Address2, RecipientAddress3, RecipientAddress4, fields and configurations for the recipient address. If using Endicia you should use the City and State fields first. Do not enter a value for the CountryCode field as it will not be output onto the label. Maximum Length: 5 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RecipientAPOFPOZip4:
APO/FPO ZIP4 code for Military Mail.Use this configuration in addition to RecipientAPOFPOZip when shipping to Military Mail. Items mailed to APO/FPO addresses may be returned unless the correct ZIP4 is submitted.
Maximum Length: 4 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RecipientTaxId: Tax Id for the recipient.Tax Id for the recipient. This configuration setting is required for Parcel Direct products when CountryCode field is set to "BR" (Brazil). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RedirectAddress:
Redirect Address.Enter the redirect address. This is a free form field.
Valid only with the REDIRECT option (NonDeliveryOption set to ndoRedirect).
Maximum Length: 48 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RedirectCity:
Redirect City.Valid only with the REDIRECT option (NonDeliveryOption set to ndoRedirect).
Maximum Length: 21 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RedirectEmail: Redirect Email.When using this config make sure to enter a complete valid e-mail address. Valid only with the REDIRECT option (NonDeliveryOption set to ndoRedirect). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RedirectName: Redirect Name.Use this config to enter a value for the recipient's name. Valid only with the REDIRECT option (NonDeliveryOption set to ndoRedirect). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RedirectSMS: Redirect SMS.This value must be a syntactically valid SMS number. Valid only with the REDIRECT option (NonDeliveryOption set to ndoRedirect). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RedirectState:
Redirect State.Valid only with the REDIRECT option (NonDeliveryOption set to ndoRedirect).
Maximum Length: 2 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RedirectZip4:
Redirect ZIP4 extension.Valid only with the REDIRECT option (NonDeliveryOption set to ndoRedirect).
Maximum Length: 4 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RedirectZipCode:
Redirect ZIP Code.Valid only with the REDIRECT option (NonDeliveryOption set to ndoRedirect).
Maximum Length: 5 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RegisteredMailValue: The value of registered mail sent in the request. This configuration setting sets the value of registered mail sent in the request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RequestId:
The ID used to identify a particular request/response pair when tracking Endicia packages.This value is required for Endicia tracking requests, and is also returned in the tracking response.
This setting is only applicable when using Endicia as your postage provider. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RubberStamp1:
Customer defined data to be printed on label.This contains the first set of user defined data that should be printed on the label. The maximum number of characters
is 50, however the actual maximum number of characters depends on the LabelSize. For example, a 4x6
default label in EPL2 format can accommodate 26 or fewer characters.
This is only valid when using Endicia. Note that Priority Mail Express and International labels will not print Rubber Stamp elements. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RubberStamp2:
Customer defined data to be printed on label.This contains the second set of user defined data that should be printed on the label. The maximum number of characters
is 50, however the actual maximum number of characters depends on the LabelSize. For example, a 4x6
default label in EPL2 format can accommodate 26 or fewer characters.
This is only valid when using Endicia. Note that Priority Mail Express and International labels will not print Rubber Stamp elements. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RubberStamp3:
Customer defined data to be printed on label.This contains the third set of user defined data that should be printed on the label. The maximum number of characters
is 50, however the actual maximum number of characters depends on the LabelSize. For example, a 4x6
default label in EPL2 format can accommodate 26 or fewer characters.
This is only valid when using Endicia. Note that Priority Mail Express and International labels will not print Rubber Stamp elements. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANFormImage:
Image of the PS Form 3152 or PS Form 5630.Image of the SCAN Form retrieved upon a successful USPSCreateManifest request.
The SCAN Form image format can be specified via LabelImageType. The only possible values are sitTIF (1) or sitPDF (3). If the SCANFormImageFile is set to a valid path and filename, the form is also saved to disk in a LabelImageType format. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANFormImageFile: The location where the SCAN Form Image will be written.This should contain the full path to where the SCAN Form Image will be written. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANFormNumber: Returns the Form Number from the last succesful call to USPSCreateManifest. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANFormType:
Indicates the SCAN Form Type that should be returned when calling USPSCreateManifest.The default value for this config is 0. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SCANPackageBarcodes:
A list of Package Barcodes to include in the SCAN Request (create a manifest for).Use this config before calling USPSCreateManifest. The value can be one or more Package Barcodes delimited with a semi-colon like this example:
class.Config("SCANPackageBarcodes=9270190317997999997976;9270202901089817001111");
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SenderUrbanization: The Urbanization that the package is being shipped from.The value of this property is optional. Use this property only when the sender's shipping address is in Puerto Rico. Zip Code prefixes 006 to 009, if area is so designated. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipTime:
Time package will be mailed.This indicates the approximate time on which the packages will be tendered to Postal Service. It should be entered in HHmmss (24 hour) format, such as 143000.
Note: This is required when calling USPSCreateManifest. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SortType:
Sort level for applicable mail classes.This specifies the sort level to be used.
The valid values are as follows:
This is required when the ServiceType is set to either stParcelSelect or stStandardMail. Also, this is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsAPIVersion:
Controls the API version used for requests.
This configuration setting sets instructs the component to work with a specific Stamps.com API version. Available versions are detailed below.
There is no need to additionally set Server when using Stamps.com. The correct server will be used automatically. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsCreateManifest:
Sends a request to create a manifest for the specified shipments.When called, the component will make a request to create a manifest for the shipments specified in StampsCreateManifestIdentifier. If StampsCreateManifestIdentifier is not set, the manifest will be created for shipments using the value in ShipDate. The manifest will be returned as a string containing a URL. Here is a short C# example.
// Using v71 of Stamps.com's API is required. A different URL needs to be used.
uspsship.USPSAccount.Server = "https://swsim.testing.stamps.com/swsim/swsimv71.asmx";
uspsship.Config("StampsCreateManifestIdentifierType=1"); // For StampsTxIds
uspsship.Config("StampsCreateManifestIdentifier=267046ae-ca90-4fef-a826-23955fab17e1;a5ed206d-d840-4a40-b314-93021391d9d0;ee1dbee9-809d-422a-9502-ee9756163619");
string manifestURL = uspsship.Config("StampsCreateManifest");
This operation requires a newer version of the API. Please use the appropriate server URL from below when calling StampsCreateManifest.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsCreateManifestId: Returns the ManifestId from the last succesful call to StampsCreateManifest. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsCreateManifestIdentifier:
A list of identifiers to create a manifest for.Set this config to one of the following:
uspsship.Config("StampsCreateManifestIdentifier=267046ae-ca90-4fef-a826-23955fab17e1;a5ed206d-d840-4a40-b314-93021391d9d0;ee1dbee9-809d-422a-9502-ee9756163619");
A Ship Date should follow this format: YYYY-MM-DD.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsCreateManifestIdentifierType:
Used to indicate the type of identifier used.Set this to the type of identifier used in StampsCreateManifestIdentifier. Possible values include:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsTestMode:
Controls whether requests are test requests or live requests.When set to 0 the class will send requests to Stamps.com's production server using the account specified in USPSAccount. When set to 1 the class will send requests to Stamps.com's sandbox server using a built-in sandbox account. There is no need to set Server in either case.
This setting only applies when PostageProvider is set to ppStamps. The default value is 0. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StampsTxId:
Stamps.com transaction identifier.This configuration setting is returned by Stamps.com after calling GetPackageLabel This setting can be used later by USPSMgr class to refund a transaction.
Note: This configuration setting is read-only and valid only for Stamps.com. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInsurance:
Specifies whether or not to request insurance.When set to true (default), the component will request that the package be insured when the InsuredValue is
set and the ServiceType is stUSPSPriorityMailInternational (84) . If false, then insurance will not be requested,
however the value in InsuredValue will still be printed on the label.
Note that this only applies when ServiceType is stUSPSPriorityMailInternational (84) . |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseStealth:
Used to determine if the postage price is printed on the label.When this is set to true (default), the postage price will not be printed on the label.
Note: Stealth cannot be used with COD, USPS Insurance, Registered Mail, Automation rate, LabelSize of EnvelopeSize10 and Card shape mailpieces. This is only valid when using Endicia. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
USPSCreateManifest:
Sends a SCAN request to create a manifest for the specified shipments.When called, the component will make a request to create a manifest. This is only applicable when using USPS as your postage provider (in other words PostageProvider is set to ppNone).
To create a manifest for one or more packages set the SCANPackageBarcodes config to a list of package barcodes and ShipDate property as well
before calling USPSCreateManifest. For example:
Note: In order for the Shipping Labels to be eligible for inclusion in a SCAN Form you have to set HoldForManifest to true when creating labels using GetPackageLabel method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VendorCode: Vendor Code to identify the developer of the shipping system.Use this config setting to set the Software Vendor Code to identify the developer of the shipping/manifesting system when using the eVS label API. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VendorProductVersionNumber: Vendor Product Version Number.Use this config setting to set the shipping Software's Product Version Number when using the eVS label API. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XAttrCount: The number of records in the XAttr arrays.This property controls the size of the following arrays: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XAttrName[i]: The name of the indexed attribute.The size of the array is controlled by XAttrCount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XAttrValue[i]: The value of the indexed attribute.The size of the array is controlled by XAttrCount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildCount: The number of records in the XChild arrays.This property controls the size of the following arrays: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildElement[i]: The name of the indexed child element.The size of the array is controlled by XChildCount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildText[i]: The text of the indexed child element.The size of the array is controlled by XChildCount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XElement: The name of the current element.The current element is specified via the XPath. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XParent: The parent of the current element.The current element is specified via the XPath. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XPath:
Used to set the XPath within the response from the server.XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the RawResponse. XPath is 1-indexed.
The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.
The following are possible values for an element accessor:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XText: The text of the current element.The current element is specified via the XPath. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AcceptEncoding: Used to tell the server which types of content encodings the client supports.When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowHTTPCompression:
This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data.
When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate". The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowHTTPFallback:
Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server
does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class throws an exception if the server does not support HTTP/2. The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowNTLMFallback: Whether to allow fallback from Negotiate to NTLM when authenticating.This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the class will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. Note: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Append: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Authorization:
The Authorization string to be sent to the server.If the Authorization property contains a nonempty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BytesTransferred: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ChunkSize: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CompressHTTPRequest:
Set to true to compress the body of a PUT or POST request.If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.
The default value is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EncodeURL: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FollowRedirects:
Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds
with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class throws an exception. Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class throws an exception instead. Following are the valid options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GetOn302Redirect: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTPVersion:
The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 NotesWhen using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed. HTTP/2 is supported on all platforms. The class will use the internal security implementation in all cases when connecting.
HTTP/3 NotesHTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IfModifiedSince:
A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request.
The value of this header is used to make the HTTP request conditional: if the requested documented has not
been modified since the time specified in the field, a copy of the document will not be returned from
the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAlive:
Determines whether the HTTP connection is closed after completion of the request.If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server
that HTTP persistent connections should be used if supported.
Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to Connection: Keep-Alive.
If False, the connection will be closed immediately after the server response is received.
The default value for KeepAlive is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogLevel:
The level of detail that is logged.This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxHeaders:
Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired.
This value represents the number of headers that are to be saved in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxHTTPCookies:
Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of
cookies that are to be saved in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxRedirectAttempts: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NegotiatedHTTPVersion: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OtherHeaders:
Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyAuthorization: The authorization string to be sent to the proxy server.This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyAuthScheme: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyPassword: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyPort: Port for the proxy server (default 80).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyServer: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyUser: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SentHeaders: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StatusLine: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredData: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredHeaders: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredRequest:
The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:
.NET
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseChunkedEncoding:
Enables or Disables HTTP chunked encoding for transfers.If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible.
HTTP-chunked encoding allows large files to be sent in chunks instead of all at once.
If set to False, the class will not use HTTP-chunked encoding. The default value is False.
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIDNs:
Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).
The default value is False and the hostname will always be used exactly as specified. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UsePlatformDeflate: Whether to use the platform implementation to decompress compressed responses.This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UsePlatformHTTPClient: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseProxyAutoConfigURL:
Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UserAgent:
Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default
setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPClient Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConnectionTimeout: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classs that do not directly expose Firewall properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallHost:
Name or IP address of firewall (optional).If a FirewallHost is given, requested connections will be authenticated through the specified firewall
when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallListener:
If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient.
If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case. RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event. The connection to the firewall is made by calling the Connect method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPassword:
Password to be used if authentication is to be used when connecting through the firewall.If FirewallHost is specified, the FirewallUser and FirewallPassword settings
are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPort:
The TCP port for the FirewallHost;.The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallType:
Determines the type of firewall to connect through.The appropriate values are as follows:
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallUser:
A user name if authentication is to be used connecting through a firewall.If the FirewallHost is specified, the FirewallUser and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveInterval:
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, TCPKeepAlive will automatically be set to True.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet
will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Linger:
When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LingerTime: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalHost:
The name of the local host through which connections are initiated or accepted.
The LocalHost setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxLineLength:
The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL
string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset. If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxTransferRate: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyExceptionsList:
A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use.
When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.nsoftware.com |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPKeepAlive:
Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically
to maintain the connection. Set KeepAliveTime and KeepAliveInterval to
configure the timing of the keep-alive packets.
Note: This value is not applicable in Java. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseNTLMv2: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSL Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogSSLPackets:
Controls whether SSL packets are logged when using the internal security API.When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if SSLProvider is set to Platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the class will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCACerts:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCheckCRL:
Whether to check the Certificate Revocation List for the server certificate.This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception.
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCheckOCSP:
Whether to use OCSP to check the status of the server certificate.This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLContextProtocol: The protocol used when getting an SSLContext instance.Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Note: This value must be set after SSLProvider is set. Example values:
Possible values when SSLProvider is set to Internal include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions. In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to 1 (Platform provider) please be aware of the following notes:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnableRenegotiation:
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate. Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLKeyLogFile:
The location of a file where per-session secrets are written for debugging purposes.This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipher:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm.Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchangeStrength:
Returns the negotiated key exchange algorithm strength.Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedVersion:
Returns the negotiated protocol version.Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLServerCACerts:
A newline separated list of CA certificate to use during SSL server certificate validation.This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLTrustManagerFactoryAlgorithm: The algorithm to be used to create a TrustManager through TrustManagerFactory.Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class throws an exception. The format of this value is a comma separated list of hash-signature combinations. For instance:
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GUIAvailable:
Tells the class whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseDaemonThreads: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms. |
Trappable Errors (Uspsshipintl Class)
USPSShipIntl Errors
301 Operation interrupted (or timeout). | |
432 Invalid index. | |
527 Server Error Response. | |
528 Property set with invalid data. | |
529 Bad Label Format. (Possibly corrupt encoding) |
SOAP Errors
169 Invalid param index (out of range). | |
170 Invalid namespace index (out of range). | |
171 Method not found. Please specify a valid Method. | |
172 No method URI. Please specify a valid MethodURI. | |
173 SOAP Fault. See FaultCode and/or FaultString for details. |
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
303 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |
XML Errors
101 Invalid attribute index. | |
102 No attributes available. | |
103 Invalid namespace index. | |
104 No namespaces available. | |
105 Invalid element index. | |
106 No elements available. | |
107 Attribute does not exist. | |
201 Unbalanced element tag. | |
202 Unknown element prefix (can't find namespace). | |
203 Unknown attribute prefix (can't find namespace). | |
204 Invalid XML markup. | |
205 Invalid end state for parser. | |
206 Document contains unbalanced elements. | |
207 Invalid XPath. | |
208 No such child. | |
209 Top element does not match start of path. | |
210 DOM tree unavailable (set BuildDOM to true and reparse). | |
302 Can't open file. | |
401 Invalid XML would be generated. | |
402 An invalid XML name has been specified. |