UPSShipIntl Class
Properties Methods Events Config Settings Errors
Allows you to generate a UPS shipping label for any of UPS international services complete with addresses and barcode, cancel shipments.
Syntax
dshippingsdk.Upsshipintl
Remarks
Generating a shipping label can be done by calling the GetShipmentLabels method. You will have to specify the package information, UPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Saturday Pickup, Saturday Delivery), and any other specific information on international shipments (such as Commercial Invoice, international forms required by Customs, etc.). It also supports many valued added services for shipments, including collect on delivery (COD), declared value, delivery confirmation, and automatic notification of delivery status.
This class also allows you to delete packages included in the daily shipping log that have not already been tendered to UPS. This can be done by calling CancelShipment or CancelPackage, where the MasterTrackingNumber parameter identifies the shipment.
To use this class, you must have a UPS AccountNumber. You should also have already obtained a UserId, Password, AccessKey uniquely assigned to your account by UPS after registration for UPS OnLine Tools.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AccountAddress | Identifies the UPS AccountNumber holder's address, if different from the sender's address. |
AccountContact | Identifies the UPS AccountNumber holder's contact info if different from SenderContact . |
CODReport | Image of a COD Turn In Page. |
CODReportFile | Filename and location to save the CODReport to. |
CODTotalAmount | The total amount to be collected on shipment level. |
CODType | The code that indicates the type of funds that will be used for the COD payment. |
CommercialInvoice | Contains specific details on Commercial Invoice (when this form is requested). |
Commodities | Collection of commodity line items. |
DutiesPayor | Identifies the payor of duty and tax charges for the requested shipment. |
Firewall | A set of properties related to firewall access. |
FormTypes | Contains the collection of types for international forms that can associate an international shipment. |
InternationalForms | Image of the international forms. |
InternationalFormsFile | Filename and location to save the InternationalForms to. |
LabelImageType | Type of image or printer commands the shipping label is to be formatted in. |
MasterTrackingNumber | Tracking number assigned to the whole MPS shipment. |
NAFTABlanketPeriod | Contains specific details on NAFTA CO (when this form is requested). |
NAFTAPreferenceCriteria | Preference Criteria for NAFTA Certificate of Origin documents. |
NAFTAProducerInfo | Producer information for NAFTA Certificate of Origin documents. |
Notify | Collection of e-mail notifications to be sent. |
Packages | A collection of packages contained in the shipment. |
Payor | Identifies the payor of transportation charges for the requested shipment. |
PickupEarliestTime | The earliest time a shipment is ready to be picked up. |
PickupLatestTime | The latest time a shipment can be picked up. |
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. |
SED | Contains specific details on SED (when this form is requested). |
SenderAddress | Identifies the sender's address. |
SenderContact | Identifies the sender's contact info. |
ServiceType | Identifies the UPS service type (applicable to international shipments) to use in a ship request. |
ShipDate | The date the user requests UPS to pickup the package from the origin. |
ShipmentDescription | A textual description of goods for the whole shipment. |
ShipmentReference | Customer-defined number (that may or may not be unique) used to identify the whole shipment. |
ShipmentSpecialServices | Contains the collection of special services offered by UPS on shipment level. |
ShipmentVoidStatus | Status description of shipment void request. |
SoldToAddress | Identifies the address of the party who imports and pays any duties due on the current shipment, or the end-user of the goods.. |
SoldToContact | Identifies the contact info of the party who imports and pays any duties due on the current shipment. |
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. |
TotalBaseCharge | The total base charge (transportation charges) applied to the whole shipment (specific to the AccountNumber ). |
TotalCustomsValue | Total customs value for the shipment. |
TotalNetCharge | The total net charge (transport charges + options charges) applied to the whole shipment (specific to the AccountNumber ). |
TotalSurcharges | The total surcharges (on all options) applied to the whole shipment (specific to the AccountNumber ). |
UPSAccount | Login information for UPS. |
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 shipping log. |
CancelPickup | Cancel a pickup. |
CancelShipment | Cancels an entire multi-package (MPS) shipment by deleting it from the shipping log. |
Config | Sets or retrieves a configuration setting. |
GetShipmentLabels | Generates a shipping label. |
Reset | Resets the internal state of the class and all properties to their default values. |
SchedulePickup | Schedules a pickup. |
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.
AccountAddress3 | Contains line three details for the Account Address. |
AccountTaxId | The Tax ID Number for the account holder. |
AccountTotalNetCharge | Net sum of negotiated rates applied to the whole shipment (if applicable). |
AdditionalDocumentIndicator | Indicates that additional documents will be supplied. |
AlternateDeliveryAddress | Used to specify an XML or SOAP aggregate for Hold for Pickup or Delivery at UPS Access Points. |
BarCodeReference | Determines whether the reference number's value will be bar coded on the shipping label. |
CertifyDirectory | The name of the directory where the files needed for Label Certification are written. |
CIPONumber | Purchase Order Number for Commercial Invoice. |
CN22CountryOfOrigin | Country of origin from where the CN22 contents originated. |
CN22FoldHereText | Will replace default 'Fold Here' text displayed on the label. |
CN22OtherDescription | Description of the type if CN22Type is 'OTHER'. |
CN22Quantity | Total number of items associated with this content. |
CN22TariffNumber | The tariff number associated with the CN22 contents. |
CN22Type | The type of CN22 form to be used. |
CurrencyCode | The currency code associated with the monetary values present in the request. |
DeclarationStatement | The declarations statement to be sent to the customs office. |
Documents | Whether an international shipment contains documents of no commercial value. |
EEIFilingXML | The XML for EEIFilingOption. |
ElectronicReturnLabel | Indicates that you are arranging for UPS to email a return label to your customer. |
EPRAReleaseCode | Package Release code that allows the consignee or claimant to pick-up a package at a UPS Access Point. |
ExportDate | The date the goods will be exiting the country. |
ExportingCarrier | The name of the carrier that is exporting the shipment. |
FRSCommodityCount | Number of commodities in the shipment. |
FRSCommodityFreightClass[i] | The freight class of the commodity at the index. |
FRSCommodityFreightNMFC[i] | The National Motor Freight Classification numbers for the commodity at the index. |
FRSCommodityFreightNMFCSub[i] | The sub-code of National Motor Freight Classification numbers for the commodity at the index. |
FRSPaymentAccountNumber | The UPS account number for the payor. |
FRSPaymentCountryCode | The country code of the payor for the Ground Freight Pricing shipment. |
FRSPaymentDescription | Description for the Ground Freight Pricing payment type. |
FRSPaymentPostalCode | The postal code of the payor for the Ground Freight Pricing shipment. |
FRSPaymentType | Method of payment for the shipment. |
HasXPath | Determines whether a specific element exists in the document. |
HazMatAdditionalDescription[i] | Additional remarks or special provision information. |
HazMataDRItemNumber[i] | The type of regulated goods for an ADR package where ADR is for Europe to Europe ground movement. |
HazMataDRPackingGroupLetter[i] | Required if the field applies to the material by regulation. Must be shown in Roman Numerals. |
HazMatAllPackedInOneIndicator[i] | Presence/Absence Indicator. |
HazMatChemicalRecordIdentifier[i] | Identifies the Chemcial Record. |
HazMatClassDivisionNumber[i] | This is the hazard class associated to the specified commodity. |
HazMatCommodityRegulatedLevelCode[i] | Indicates the type of commodity. |
HazMatEmergencyContact[i] | The emergency information, contact name and/or contract number. |
HazMatEmergencyPhone[i] | 24 Hour Emergency Phone Number of the shipper. |
HazMatHazardLabelRequired[i] | Defines the type of label that is required on the package for the commodity. |
HazMatIDNumber[i] | This is the ID number (UN/NA/ID) for the specified commodity. |
HazMatOverPackedIndicator[i] | Presence/Absence Indicator. |
HazMatPackageIdentifier[i] | Identifies the package containing Dangerous Goods. |
HazMatPackagingGroupType[i] | This is the packing group category associated to the specified commodity. |
HazMatPackagingInstructionCode[i] | The packing instructions related to the chemical record. |
HazMatPackagingType[i] | The type of package used to contain the regulated good. |
HazMatPackagingTypeQuantity[i] | The number of pieces of the specific commodity. |
HazMatProperShippingName[i] | The Proper Shipping Name assigned by ADR, CFR or IATA. |
HazMatQuantity[i] | . |
HazMatQValue[i] | . |
HazMatReferenceNumber[i] | Optional reference number. Will be displayed only on label. |
HazMatRegulationSet[i] | The Regulatory set associated with every regulated shipment. |
HazMatReportableQuantity[i] | . |
HazMatSubRiskClass[i] | Secondary hazardous characteristics of a package. |
HazMatTechnicalName[i] | The technical name (when required) for the specified commodity. |
HazMatTransportationMode[i] | Declares that a package was prepared according to ground, passenger aircraft, or cargo aircraft only. |
HazMatTransportCategory[i] | Transport Category. |
HazMatTunnelRestrictionCode[i] | . |
HazMatUOM[i] | . |
HighValueReport | High Value Report (if applicable). |
HighValueReportFileName | Name of High Value Report (if applicable). |
ImportControlCode | Code for type of ImportControl label. |
ImportControlDescription | Description for ImportControl. |
IncludeNegotiatedRates | Whether to include the NegotiatedRatesIndicator in the request. |
InvoiceDiscount | The discount to be subtracted from the total value on the invoice. |
IrregularIndicator | The mail classification defined by UPS. |
ItemizedChargesCode[i] | The Accesorial/Surcharge code of the itemized charge. |
ItemizedChargesCount | The count of itemized charges. |
ItemizedChargesCurrencyCode[i] | The currency used for the charge. |
ItemizedChargesMonetaryValue[i] | The amount being charged. |
ItemizedChargesSubType[i] | The subtype of the itemized charge. |
LabelSize | The size of the label. |
Machineable | Determines whether the package is machineable or not. |
MasterCartonId | Master Carton ID. |
MasterCartonIndicator | Determines whether to include the MasterCartonIndicator in the request. |
MICostCenter | Customer assigned identifier for report and billing summarization displays to the right of the Cost Center title. |
MILabelCN22 | Determines whether the MILabelCN22Indicator is included in the request. |
MIPackageID | Customer assigned unique piece identifier that returns visibility events. |
NAFTAExcludeFromForm[i] | Excludes the commodity from NAFTA form (corresponding to the commodity at index i). |
NotificationDialect | Used to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications. |
NotificationLanguage | Used to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications. |
OtherCharges | The amount of all additional charges. |
OtherChargesDescription | The reason for the other charges. |
OverridePaperlessIndicator | Indicates that a copy of the invoice and NAFTA Certificate of Origin should be provided. |
Overwrite | Determines whether label files will be overwritten. |
PackageDeclaredValueType[i] | The type of declared value (corresponding to the package at index i). |
PackageShippingLabelFileHTML[i] | Name of the file where the HTML image of the shipping label (corresponding to the package at index i) is saved to disk. |
PackageShippingLabelHTML[i] | HTML version of the shipping label (corresponding to the package at index i). |
PickupEarliestTime | The earliest time a shipment is ready to be picked up. |
PickupFloorNumber | The floor number of the pickup location. |
PickupLatestTime | The latest time a shipment can be picked up. |
PickupRoomNumber | The room number of the pickup location. |
RawRequest | Contains the complete request sent to the Server. |
RawResponse | Contains the complete response returned by the Server. |
RecipientAddress3 | Contains line three details for the Recipient Address. |
RecipientTaxId | The Tax ID Number for the recipient. |
RequestDeliveryConfirmation | Whether or not to request delivery confirmation for the package/shipment. |
RequestOption | Defines if the address should be validated or not. |
ReturnFreightPrices | When true, UPS will use applicable freight pricing for shipments. |
ReturnPrintAndMail | Indicates that you are arranging for UPS to print and mail a return label to your customer. |
ReturnServiceFirstAttempt | Indicates that you are arranging for UPS to make one attempt to pick up the package to be returned. |
ReturnServiceThirdAttempt | Indicates that you are arranging for UPS to make three attempts to pick up the package to be returned. |
ReturnsFlexibleAccessIndicator | Defines if the Returns Flexible Access service should be used. |
SendDutiesPayor | Indicates whether to send the duties payor information or not. |
SenderAddress3 | Contains line three details for the Sender Address. |
SenderTaxId | The Tax ID Number for the sender. |
ShipmentAcceptRequest | Contains the Shipment Accept Request sent to UPS. |
ShipmentAcceptResponse | Contains the Shipment Accept Response returned by UPS. |
ShipmentConfirmRequest | Contains the Shipment Confirm Request sent to UPS. |
ShipmentConfirmResponse | Contains the Shipment Confirm Response returned by UPS. |
ShipmentDescription | A textual description of goods for the whole shipment when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments. |
ShipmentIndicationType | Whether shipment is Hold For Pickup or Delivery at UPS Access Points. |
ShipmentSignatureType | Shipment signature type at the shipment level. |
ShippingLabelHTMLDirectory | The name of the directory where the shipping label files are written. |
SoldToTaxId | The Tax ID Number for the person or business the product was sold to. |
SplitDutyVATIndicator | Indicates that whether or not the duties and taxes are split. |
SubVersion | UPS SubVersion. |
TaxInformationIndicator | Controls whether to send a TaxInformationIndicator. |
TotalCustomsValue | Invoice Line Total Monetary Value when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments. |
UseSOAP | Whether or not to use UPS' webservices. |
USPSEndorsement | The USPS endorsement type for Mail Innovations and SurePost shipments. |
USPSPICNumber[i] | USPS Tracking Number (corresponding to the package at index i). |
VerbalConfirmationName | The contact name for verbal confirmation. |
VerbalConfirmationPhone | The contact phone number for verbal confirmation. |
Warning | Warning message returned by the server. |
WeightUnit | Weight unit. |
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. |
AccountAddress Property (UPSShipIntl Class)
Identifies the UPS AccountNumber holder's address, if different from the sender's address.
Syntax
public AddressDetail getAccountAddress(); public void setAccountAddress(AddressDetail accountAddress);
Remarks
The AccountAddress is required to be provided in a ship request only if the SenderAddress is different from the billing address of the AccountNumber. Otherwise, it defaults to SenderAddress. For international shipments, even when account address is different from sender's address, the CountryCode should be the same as CountryCode.
This must be set to an instance of the AddressDetail type, which will contain the address info corresponding to the AccountNumber. See the AddressDetail type for more information.
AccountContact Property (UPSShipIntl Class)
Identifies the UPS AccountNumber holder's contact info if different from SenderContact .
Syntax
public ContactDetail getAccountContact(); public void setAccountContact(ContactDetail accountContact);
Remarks
If different from SenderContact, the AccountContact is required to be provided in a ship request. Otherwise, it defaults to SenderContact.
If the CountryCode is international, or if Commercial Invoice and other International forms are requested, the FirstName and LastName are required to be provided in the request.
The AccountContact must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact shipper. See the ContactDetail type for more information.
CODReport Property (UPSShipIntl Class)
Image of a COD Turn In Page.
Syntax
public byte[] getCODReport();
Default Value
""
Remarks
This applies only to shipments within the European Union (EU) countries. It is the decoded binary image file of the COD report, stored in memory upon successful ship response. The report is generated in HTML format and it will automatically be saved to disk in the file designated by CODReportFile (if this is set to a valid path and filename).
This property is read-only.
CODReportFile Property (UPSShipIntl Class)
Filename and location to save the CODReport to.
Syntax
public String getCODReportFile(); public void setCODReportFile(String CODReportFile);
Default Value
""
Remarks
This applies only to shipments within the European Union (EU) countries. When applicable and the CODReportFile is set to a valid path and filename, the contents of the CODReport are written to disk upon successful response.
This has to have .html extension.
CODTotalAmount Property (UPSShipIntl Class)
The total amount to be collected on shipment level.
Syntax
public String getCODTotalAmount(); public void setCODTotalAmount(String CODTotalAmount);
Default Value
""
Remarks
This indicates customer's input COD amount (prior to any accumulations: total collection amount minus transportation charges).
For MPS COD shipments (when Packages is greater than 1), the COD amount must be included on each package that uses COD service by setting the CODAmount.
Format: Two explicit decimals (e.g.5.00).
CODType Property (UPSShipIntl Class)
The code that indicates the type of funds that will be used for the COD payment.
Syntax
public int getCODType(); public void setCODType(int CODType); Enumerated values: public final static int codtsCash = 0; public final static int codtsCheck = 1;
Default Value
0
Remarks
This property identifies the type of funds UPS should collect upon shipment delivery. It is required to be provided in the request only if COD is requested (i.e., CODTotalAmount is set to a value other than "0.00").
Valid values are:
Value | Meaning |
codtsCash (0) | Only cash is allowed as form of payment. |
codtsCheck (1) | Personal check, cashier's check or money order - no cash allowed. |
Note: COD special service is not valid for return service movements.
CommercialInvoice Property (UPSShipIntl Class)
Contains specific details on Commercial Invoice (when this form is requested).
Syntax
public CommercialInvoiceDetail getCommercialInvoice(); public void setCommercialInvoice(CommercialInvoiceDetail commercialInvoice);
Remarks
This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if Commercial Invoice international form is requested (i.e., one of the FormTypes is set to Invoice).
This must be set to an instance of the CommercialInvoiceDetail type, which will contain specific information about the Commercial Invoice (CI) that is requested to associate an international shipment. See the CommercialInvoiceDetail type for more information.
Commodities Property (UPSShipIntl Class)
Collection of commodity line items.
Syntax
public CommodityDetailList getCommodities(); public void setCommodities(CommodityDetailList commodities);
Remarks
The Commodities is required to be provided in any international shipment request only if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.
For international multiple piece shipments (MPS), commodity information will be passed in the Master and on each subsequent package. If this shipment contains more than four commodities line items, the four highest valued should be included in the request.
For each idx = 0 to CommodityCount - 1, this must be set to an instance of the CommodityDetail type, which will contain specific information about a commodity item contained in the shipment. See the CommodityDetail type for more information.
Each commodity item has a: NumberOfPieces (required), Description (required), Manufacturer (required), HarmonizedCode (optional), Weight (conditional), Quantity (optional), QuantityUnit (optional), UnitPrice (optional), and ExportType (conditional) tied to it.
For instance, to send a package containing 2 computer softwares and 5 iPods:
class.Commodities[0].NumberOfPieces = 2;
class.Commodities[0].Description = "computer software";
class.Commodities[0].Manufacturer = "US"; // country of manufacturer
class.Commodities[0].Weight = "0.5"; // each software box weighs .5 lbs
class.Commodities[0].QuantityUnit = "EA"; // for 'each'
class.Commodities[0].UnitPrice = "100.00"; // each software priced at $100
class.Commodities[1].NumberOfPieces = 5;
class.Commodities[1].Description = "portable digital audio player";
class.Commodities[1].Manufacturer = "US"; // country of manufacturer
class.Commodities[1].Weight = "0.5"; // each iPod weighs .5 lbs
class.Commodities[1].QuantityUnit = "EA"; // for 'each'
class.Commodities[1].UnitPrice = "150.00"; // each iPod priced at $150
This property is not available at design time.
DutiesPayor Property (UPSShipIntl Class)
Identifies the payor of duty and tax charges for the requested shipment.
Syntax
public PayorDetail getDutiesPayor(); public void setDutiesPayor(PayorDetail dutiesPayor);
Remarks
This is applicable to and required for international shipments only, and only if origin and destination countries are different (i.e., the CountryCode is different than CountryCode), and the shipment is not US/PR or PR/US.
The ZipCode is required for United States and Canadian UPS accounts and/or if the UPS account pickup address has a postal code. If the UPS account's pickup country is US or Puerto Rico, the postal code is 5 or 9 digits. The character '-' may be used to separate the first five digits and the last four digits. If the UPS account's pickup country is CA, the postal code is 6 alphanumeric characters.
This must be set to an instance of the PayorDetail type, which will contain the duties payor details. See the PayorDetail type for more information.
Firewall Property (UPSShipIntl 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.
FormTypes Property (UPSShipIntl Class)
Contains the collection of types for international forms that can associate an international shipment.
Syntax
public int getFormTypes(); public void setFormTypes(int formTypes);
Default Value
0
Remarks
The FormTypes property is optional. Up to 4 international forms (such as Invoice, Shipper's Export Declaration, Certificate of Origin, or NAFTA Certificate of Origin) can be requested within a ship request. To request any of the forms offered by UPS, you must set the FormTypes to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:
Value | Meaning |
0x00000001 | Invoice |
0x00000002 | Shipper's Export Declaration |
0x00000004 | Certificate of Origin |
0x00000008 | NAFTA Certificate of Origin |
0x00000010 | CN22 |
0x00000020 | EEI |
0x00000040 | Partial Invoice |
For instance, to request both a Commercial Invoice and a CN22 you could set the property like below:
upsshipintl1.FormTypes = 0x00000011
Note: Invoice and Partial Invoice are mutually exclusive.
InternationalForms Property (UPSShipIntl Class)
Image of the international forms.
Syntax
public byte[] getInternationalForms();
Default Value
""
Remarks
This is the decoded binary image file of the international forms accompanying the shipment already requested via the FormTypes property (such as Invoice, SED, Certificate of Origin, etc.), stored in memory upon successful international ship response. If the InternationalFormsFile is set to a valid path and filename, the international forms are also saved to disk in PDF format.
This property is read-only.
InternationalFormsFile Property (UPSShipIntl Class)
Filename and location to save the InternationalForms to.
Syntax
public String getInternationalFormsFile(); public void setInternationalFormsFile(String internationalFormsFile);
Default Value
""
Remarks
When the InternationalFormsFile is set to a valid path and filename, the contents of the InternationalForms are written to disk upon successful response.
The InternationalFormsFile has to have .pdf extension.
LabelImageType Property (UPSShipIntl Class)
Type of image or printer commands the shipping label is to be formatted in.
Syntax
public int getLabelImageType(); public void setLabelImageType(int labelImageType); Enumerated values: public final static int uitGIF = 0; public final static int uitEPL = 1; public final static int uitSPL = 2; public final static int uitZPL = 3; public final static int uitStar = 4;
Default Value
0
Remarks
This element defines the print method code that the labels are to be generated to. It is applicable and required to be provided in a ship request for forward shipments or return shipments. The value selection depends on the printer type used to print the shipping label.
Valid image types and their meanings with the corresponding usage are listed below:
Value | Usage |
uitGIF(0) | To be used for image formats. |
uitEPL (1) | To be used with EPL2 formatted labels. |
uitSPL (2) | To be used with SPL formatted labels. |
uitZPL (3) | To be used with ZPL formatted labels. |
uitStar (4) | To be used with STAR printer formatted labels. Not a valid image type when using Mail Innovations. |
There are two types of shipping labels supported: plain paper (when printing to an HP compatible laser or inkjet type printer only. In this case, the only possible value for the LabelImageType is 0 (litGIF)), and thermal (when printing to thermal printers only. In this case, possible values for the LabelImageType are 1, 2, 3 and 4).
While the content of each of these labels is the same, their usages are different. Each provides a bar-coded image for the purpose of scanning the package during handling. The uses of each label depend on the type of working environment to be used.
MasterTrackingNumber Property (UPSShipIntl Class)
Tracking number assigned to the whole MPS shipment.
Syntax
public String getMasterTrackingNumber();
Default Value
""
Remarks
This is applicable to MPS shipment requests only and identifies the whole shipment. In a MPS ship request, this property is returned in the server reply when the GetShipmentLabels method is called.
This value is used as parameter when a cancel shipment request is sent (i.e., when the CancelShipment method is called). It can also be used when tracking a MPS.
This property is read-only.
NAFTABlanketPeriod Property (UPSShipIntl Class)
Contains specific details on NAFTA CO (when this form is requested).
Syntax
public String getNAFTABlanketPeriod(); public void setNAFTABlanketPeriod(String NAFTABlanketPeriod);
Default Value
""
Remarks
This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if NAFTA CO international form is requested (i.e., one of the FormTypes is set to NAFTA).
This contains the begin date and the end date of the blanket period. The begin date is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). The end date is the date upon which the blanket period expires.
This is applicable and required to be provided in the request only if the NAFTA Certificate covers multiple shipments of identical goods as described in the ShipmentDescription that are imported into a NAFTA country for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between beginning and ending dates.
Format is: YYYYMMDD-YYYYMMDD
NAFTAPreferenceCriteria Property (UPSShipIntl Class)
Preference Criteria for NAFTA Certificate of Origin documents.
Syntax
public String getNAFTAPreferenceCriteria(); public void setNAFTAPreferenceCriteria(String NAFTAPreferenceCriteria);
Default Value
""
Remarks
This property is required when the FormTypes property includes the NAFTA flag. Valid values and their descriptions are listed from the UPS documentation:
Value | Description |
"A" | The good is "wholly obtained or produced entirely" in the territory of one or more of the NAFTA countries as referenced in Article 415. Note: The purchase of a good in the territory does not necessarily render it "wholly obtained or produced." If the good is an agricultural good, see also criterion F and Annex 703.2. (Reference: Article 401(a) and 415) |
"B" | The good is produced entirely in the territory of one or more of the NAFTA countries and satisfies the specific rule of origin, set out in Annex 401, that applies to its tariff classification. The rule may include a tariff classification change, regional value-content requirement, or a combination there-of. The good must also satisfy all other applicable requirements of Chapter Four. If the good is an agricultural good, see also criterion F and Annex 703.2. (Reference: Article 401(b)) |
"C" | The good is produced entirely in the territory of one or more of the NAFTA countries exclusively from originating materials. Under this criterion, one or more of the materials may not fall within the definition of "wholly produced or obtained," as set out in Article 415. All materials used in the production of the good must qualify as "originating" by meeting the rules of Article 401(a) through (d). If the good is an agricultural good, see also criterion F and Annex 703.2. Reference: Article 401(c). |
"D" | Goods are produced in the territory of one or more of the NAFTA countries but do not meet the applicable rule of origin, set out in Annex 401, because certain non-originating materials do not undergo the required change in tariff classification. The goods do nonetheless meet the regional value-content requirement specified in Article 401 (d). This criterion is limited to the following two circumstances: (1) The good was imported into the territory of a NAFTA country in an unassembled or disassembled form but was classified as an assembled good, pursuant to H.S. General Rule of Interpretation 2(a). or (2). The good incorporated one or more non-originating materials, provided for as parts under the H.S., which could not undergo a change in tariff classification because the heading provided for both the good and its parts and was not further subdivided into subheadings, or the subheading provided for both the good and its parts and was not further subdivided. Note: This criterion does not apply to Chapters 61 through 63 of the H.S. (Reference: Article 401(d)) |
"E" | Certain automatic data processing goods and their parts, specified in Annex 308.1, that do not originate in the territory are considered originating upon importation into the territory of a NAFTA country from the territory of another NAFTA country when the most-favored-nation tariff rate of the good conforms to the rate established in Annex 308.1 and is common to all NAFTA countries. (Reference: Annex 308.1) |
"F" | The good is an originating agricultural good under preference criterion A, B, or C above and is not subject to a quantitative restriction in the importing NAFTA country because it is a "qualifying good" as defined in Annex 703.2, Section A or B (please specify). A good listed in Appendix 703.2B.7 is also exempt from quantitative restrictions and is eligible for NAFTA preferential tariff treatment if it meets the definition of "qualifying good" in Section A of Annex 703.2. |
NAFTAProducerInfo Property (UPSShipIntl Class)
Producer information for NAFTA Certificate of Origin documents.
Syntax
public int getNAFTAProducerInfo(); public void setNAFTAProducerInfo(int NAFTAProducerInfo); Enumerated values: public final static int piYes = 0; public final static int piNo1 = 1; public final static int piNo2 = 2; public final static int piNo3 = 3;
Default Value
0
Remarks
This property is required when the FormTypes property includes the NAFTA flag.
From UPS documentation, specify: piYes - If shipper is the producer of the good. If not, state No depending on whether this certificate was based upon: piNo1 - Knowledge of whether the good qualifies as an originating good. piNo2 - Reliance on the producer's written representation (other than a Certificate of Origin) that the good qualifies as an originating good. piNo3 - A completed and signed Certificate for the good voluntarily provided to the exporter by the producer.
Notify Property (UPSShipIntl Class)
Collection of e-mail notifications to be sent.
Syntax
public NotifyDetailList getNotify(); public void setNotify(NotifyDetailList notify);
Remarks
The Notify is optional to be provided in a ship request. This should be set only if the shipper wants to send e-mail notifications on shipment status, exceptions, and/or delivery status. Up to 3 notification requests can be made within a ship request.
For each idx = 0 to NotifyCount - 1 (where NotifyCount<=2), this must be set to an instance of the NotifyDetail type, which will contain specific information about the notification to be e-mailed. See the NotifyDetail type for more information.
Each notification has a: NotificationFlags (required), Email (required), Message (optional) tied to it.
For instance, if only one notification is requested to be sent:
class.Notify[0].Email = "test@test.com";
class.Notify[0].NotificationFlags = 0x00000001; // On Shipment
class.Notify[0].Message = "test";
This property is not available at design time.
Packages Property (UPSShipIntl 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 UPS, the PackagingType is required. The Description is optional. The Weight, Length, Width, and Height are all conditionally required. More information can be found in the individual field definitions.
This property is not available at design time.
Payor Property (UPSShipIntl Class)
Identifies the payor of transportation charges for the requested shipment.
Syntax
public PayorDetail getPayor(); public void setPayor(PayorDetail payor);
Remarks
The Payor is required to be provided in a ship request. This must be set to an instance of the PayorDetail type, which will contain the payor details. See the PayorDetail type for more information.
PickupEarliestTime Property (UPSShipIntl Class)
The earliest time a shipment is ready to be picked up.
Syntax
public String getPickupEarliestTime(); public void setPickupEarliestTime(String pickupEarliestTime);
Default Value
""
Remarks
This is required when calling SchedulePickup. This contains the earliest time UPS can come to pickup the package.
This should be entered in this format: HHmm.
PickupLatestTime Property (UPSShipIntl Class)
The latest time a shipment can be picked up.
Syntax
public String getPickupLatestTime(); public void setPickupLatestTime(String pickupLatestTime);
Default Value
""
Remarks
This is required when calling SchedulePickup. This contains the latest time UPS can come to pickup the package.
This should be entered in this format: HHmm.
Proxy Property (UPSShipIntl 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 (UPSShipIntl 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 (UPSShipIntl 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 Company is required to be provided in the request. In domestic shipments: the FirstName and LastName are required when using UPS Next Day Air Early A.M. service. In international shipments: the FirstName and LastName are required when the CountryCode is different than CountryCode, and if Commercial Invoice international form is requested.
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.
SED Property (UPSShipIntl Class)
Contains specific details on SED (when this form is requested).
Syntax
public SEDDetail getSED(); public void setSED(SEDDetail SED);
Remarks
This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if SED international form is requested (i.e., one of the FormTypes is set to SED).
This must be set to an instance of the SEDDetail type, which will contain specific information about the SED that is requested to associate an international shipment. See the SEDDetail type for more information.
SenderAddress Property (UPSShipIntl 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 GetShipmentLabels 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 (UPSShipIntl 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 GetShipmentLabels 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.
ServiceType Property (UPSShipIntl Class)
Identifies the UPS service type (applicable to international shipments) to use in a ship request.
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 GetShipmentLabels method is called.
Note that the availability and the description of UPS services depend on the country of origin. Possible values of ServiceType and their corresponding availability to each group country origin are listed below:
Value | Applicable for |
stUPSPriorityMailInnovations (38) | All origins, requires a contract with Mail Innovations, single package shipments only |
stUPSEconomyMailInnovations (39) | All Origins, requires a contract with Mail Innovations, single package shipments only |
stUPSNextDayAir (40) | Originating only in US/PR |
stUPSExpress (41) | Polish Domestic Shipments; All Origins |
stUPS2ndDayAir (42) | Originating only in US/PR |
stUPSGround (43) | Originating only in US/PR |
stUPSWorldwideExpress (44) | Originating only in US/PR |
stUPSWorldwideExpedited (45) | US/PR, Canada and Non-EU origins, EXCEPT Mexico |
stUPSExpedited (46) | Polish Domestic Shipments; Originating in EU or Mexico |
stUPSStandard (47) | Polish Domestic Shipments; All Origins |
stUPS3DaySelect (48) | Originating in CA or US |
stUPSSaver (50) | Polish Domestic Shipments; All Origins |
stUPSNextDayAirEarlyAM (51) | Originating in CA or US/PR |
stUPSExpressEarlyAM (52) | Originating only in CA |
stUPSWorldwideExpressPlus (53) | Polish Domestic Shipments; All Origins EXCEPT Canada and Mexico |
stUPSExpressPlus (54) | Originating only in Mexico |
stUPS2ndDayAirAM (55) | Originating only in US |
stUPSTodayStandard (56) | Polish Domestic Shipments (Stolica) |
stUPSTodayCourrier (57) | Polish Domestic Shipments (Stolica) |
stUPSTodayInterCity (58) | Polish Domestic Shipments (Stolica) |
stUPSTodayExpress (59) | Polish Domestic Shipments (Stolica) |
stUPSTodayExpressSaver (60) | Polish Domestic Shipments (Stolica) |
stUPSWorldwideEconomyDDU (131) | Originating in Canada or US, requires a contract with UPS |
stUPSWorldwideEconomyDDP (132) | Originating in Canada or US, requires a contract with UPS |
This property is not available at design time.
ShipDate Property (UPSShipIntl Class)
The date the user requests UPS to pickup the package from the origin.
Syntax
public String getShipDate(); public void setShipDate(String shipDate);
Default Value
""
Remarks
This is required to be provided in a ship request only if UPS On-Call Pickup service is requested (i.e., when the corresponding flag for On-Call Pickup (0x01000000) is present in ShipmentSpecialServices). This date should not be a past date or a date more than 10 days in the future. If not provided, then it defaults to the current date.
This should be entered in this format: YYYYMMDD.
Note: It is not valid if this pickup date is the same day for shipment(s) going from Germany to Germany using UPS Standard service. Error 129090 will be returned in this case.
ShipmentDescription Property (UPSShipIntl Class)
A textual description of goods for the whole shipment.
Syntax
public String getShipmentDescription(); public void setShipmentDescription(String shipmentDescription);
Default Value
""
Remarks
This is applicable to international shipments only. Provide a detailed description of items being shipped for documents and non-documents, such as 'annual reports', '9 mm steel screws', etc..
This is required to be provided in a ship request if all of the listed conditions are true:
- the CountryCode and CountryCode are not the same;
- the CountryCode and/or CountryCode are not in the European Union; or the CountryCode and CountryCode are both in the European Union; and ServiceType is not 'UPS Standard'.
- the packaging type of any packages contained in the shipment is not 'UPS Letter';
Maximum length: 35 characters.
ShipmentReference Property (UPSShipIntl Class)
Customer-defined number (that may or may not be unique) used to identify the whole shipment.
Syntax
public String getShipmentReference(); public void setShipmentReference(String shipmentReference);
Default Value
""
Remarks
This is applicable to international shipments only. Valid if the origin/destination pair is not US/US or PR/PR.
This is optional to be provided in a ship request (when the GetShipmentLabels method is called). You can enter up to two customer references on shipment level by providing: the type(s) and value(s) in the request.
Valid values for types are:
Code | Reference Number Type |
AJ | Accounts Receivable Customer Account |
AT | Appropriation Number |
BM | Bill of Lading Number |
9V | Collect on Delivery (COD) Number |
ON | Dealer Order Number |
DP | Department Number |
3Q | Food and Drug Administration (FDA) Product Code |
IK | Invoice Number |
MK | Manifest Key Number |
MJ | Model Number |
PM | Part Number |
PC | Production Code |
PO | Purchase Order Number |
RQ | Purchase Request Number |
RZ | Return Authorization Number |
SA | Salesperson Number |
SE | Serial Number |
ST | Store Number |
TN | Transaction Reference Number |
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 shipment, the ShipmentReference 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 shipment by reference.
ShipmentSpecialServices Property (UPSShipIntl Class)
Contains the collection of special services offered by UPS 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 UPS in a request, 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 |
0x00008000L | Hold for Pickup |
0x00100000L | Liftgate Dropoff |
0x00200000L | Liftgate Pickup |
0x08000000L | Return Shipment |
0x10000000L | Saturday Delivery |
0x20000000L | Saturday Pickup |
0x20000000000L | Return of Document |
0x40000000000L | Import Control |
0x80000000000L | Commercial Invoice Removal |
0x0100000000000L | Exchange Forward |
0x0200000000000L | Carbon Neutral |
0x0400000000000L | Dropoff at UPS Facility |
0x0020000000000000L | Deliver To Addressee Only |
0x0040000000000000L | Direct Delivery Only |
The meaning and limitations for each special service option are listed below:
- Hold for Pickup:
This indicates that UPS should deliver your package to the UPS Customer Center you choose and then call the recipient
when the package is ready.
This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.
- Liftgate Dropoff:
This requests that UPs provide their liftgate services unload a shipment when unloading docks are not available.
This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.
- Liftgate Pickup:
This requests that UPs provide their liftgate services load a shipment when loading docks are not available.
This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.
- Return Shipment:
This is applicable to return shipments only. Indicates that the ship request is made for Print Return Label (PRL).
With this option you can print a return label to include in an outbound shipment, or provide a label to your customer separately.
If you want to arrange for UPS to mail a return label to your customer, you can use the ReturnPrintAndMail config setting.
If you want to arrange for UPS to email a return label to your customer, you can use the ElectronicReturnLabel config setting.
If you want to arrange for UPS to make one attempt to pick up the package to be returned, you can use the ReturnServiceFirstAttempt config setting.
If you want to arrange for UPS to make three attempts to pick up the package to be returned, you can use the ReturnServiceThirdAttempt config setting.
Using the last 4 options: in the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.
For return shipments, one of the following conditions must be met on CountryCode, CountryCode and CountryCode: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for FormTypes. The availability of return service depends on the origin and destination country code, and on the selected ServiceType. The Description is required to be provided in the request for each package contained in the shipment. The PackagingType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only.
Also please note that when you set this option that only the return label is being printed, you must submit a separate request to print the shipping label.
- Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is not available for return shipments.
- Saturday Pickup: The presence indicates Saturdary pickup is requested. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair.
- Return of Document: This may also be referred to as the Return of Invoice service and is unique to Poland. If set UPS will use their Return of Document service to return the signed invoice to the shipper.
- Commercial Invoice Removal: When set this will indicate that the commercial invoice should be removed before delivery, thus not revealing the value of the contents to the recipient.
- Carbon Neutral: This is required to make a shipment that is carbon neutral.
- Exchange Forward: This is required in order to make exchange forward shipments.
- Dropoff at UPS Facility:
When set this indicates that the package will be dropped off at a UPS Facility.
This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.
- Deliver To Addressee Only:
When set this requires that the addressee be the one who takes final delivery of the package being held at a UPS Access Point
This accessorial is only valid when ShipmentIndicationType is set to 1.
- Direct Delivery Only:
When set this will ensure that the package is delivered to the ShipTo address on the shipping label.
This accessorial is not valid when ShipmentIndicationType is set.
ShipmentVoidStatus Property (UPSShipIntl Class)
Status description of shipment void request.
Syntax
public String getShipmentVoidStatus();
Default Value
""
Remarks
Upon successful response, this is populated when the CancelShipment or CancelPackage method is called.
This property is read-only.
SoldToAddress Property (UPSShipIntl Class)
Identifies the address of the party who imports and pays any duties due on the current shipment, or the end-user of the goods..
Syntax
public AddressDetail getSoldToAddress(); public void setSoldToAddress(AddressDetail soldToAddress);
Remarks
The SoldToAddress represents address details of the party who imports and pays any duties due on the shipment, or the end-user. It is required to be provided in an international ship request only if this party is different from recipient, and if Commercial Invoice, NAFTA CO, and/or SED international forms are requested.
- in Commercial Invoice or NAFTA CO forms: SoldToAddress represents the party's address who imports and pays any duties due on the current shipment.
- in SED form: SoldToAddress represents the person or company's address who receives the goods for end-use or the person or company listed on the export license. This is the end-user of the goods.
This must be set to an instance of the AddressDetail type, which will contain this party's address info. See the AddressDetail type for more information.
If not set, it will default to RecipientAddress.
SoldToContact Property (UPSShipIntl Class)
Identifies the contact info of the party who imports and pays any duties due on the current shipment.
Syntax
public ContactDetail getSoldToContact(); public void setSoldToContact(ContactDetail soldToContact);
Remarks
The SoldToContact represents descriptive contact data identifying the party who imports and pays any duties due on the shipment, or the end-user. It is required to be provided in an international ship request only if this party is different from recipient, and if Commercial Invoice, NAFTA CO, and/or SED international forms are requested.
- in Commercial Invoice or NAFTA CO forms: SoldToAddress represents the party's contact who imports and pays any duties due on the current shipment.
- in SED form: SoldToAddress represents the person or company's contact who receives the goods for end-use or the person or company listed on the export license. This is the end-user of the goods.
If not set, it will default to RecipientContact.
SSLAcceptServerCert Property (UPSShipIntl 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 (UPSShipIntl 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 (UPSShipIntl 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 (UPSShipIntl 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 (UPSShipIntl 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.
TotalBaseCharge Property (UPSShipIntl Class)
The total base charge (transportation charges) applied to the whole shipment (specific to the AccountNumber ).
Syntax
public String getTotalBaseCharge();
Default Value
""
Remarks
In a MPS ship request, this represents the total base charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as BaseCharge at index=0.
This property is read-only.
TotalCustomsValue Property (UPSShipIntl Class)
Total customs value for the shipment.
Syntax
public String getTotalCustomsValue(); public void setTotalCustomsValue(String totalCustomsValue);
Default Value
"1"
Remarks
The TotalCustomsValue is required to be provided in an international shipment request only if the following requirements are met:
- the CountryCode is US;
- the CountryCode is either CA (Canada) or PR (PuertoRico);
- the shipment does not contain any package of UPS Letter type;
Format: Whole number, no decimal position (e.g. 100) with maximum length of 8 digits. Possible values: 1 to 99999999.
TotalNetCharge Property (UPSShipIntl Class)
The total net charge (transport charges + options charges) applied to the whole shipment (specific to the AccountNumber ).
Syntax
public String getTotalNetCharge();
Default Value
""
Remarks
In a MPS ship request, this represents the total net charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as NetCharge at index=0.
This property is read-only.
TotalSurcharges Property (UPSShipIntl Class)
The total surcharges (on all options) applied to the whole shipment (specific to the AccountNumber ).
Syntax
public String getTotalSurcharges();
Default Value
""
Remarks
In a MPS ship request, this represents the total surcharges applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as TotalSurcharges at index=0.
This property is read-only.
UPSAccount Property (UPSShipIntl Class)
Login information for UPS.
Syntax
public UPSAccount getUPSAccount(); public void setUPSAccount(UPSAccount UPSAccount);
Remarks
This property must be set when connecting to UPS server. It contains server and login information.
CancelPackage Method (Upsshipintl Class)
Cancels a single package by deleting it from the shipping log.
Syntax
public void cancelPackage(String masterTrackingNumber, String packageTrackingNumber);
Remarks
To cancel shipment of a single package, a void shipment request should be sent to UPS Server by calling the CancelPackage method.
For void shipment requests while your application is undergoing testing and integration, you will have to set the Server to: https://wwwcie.ups.com/ups.app/xml/Void.
Once your application is in production, the Server should be sent to the URL provided as part of the certification process.
The TrackingNumber parameter identifies the package to be deleted from the shipping log.
This method will return the void status of the specified package.
To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.
CancelPickup Method (Upsshipintl Class)
Cancel a pickup.
Syntax
public void cancelPickup(String confirmationNumber);
Remarks
When called the pickup referenced by the ConfirmationNumber will be canceled.
CancelShipment Method (Upsshipintl Class)
Cancels an entire multi-package (MPS) shipment by deleting it from the shipping log.
Syntax
public void cancelShipment(String masterTrackingNumber);
Remarks
To cancel an entire MPS shipment, a void shipment request should be sent to UPS Server by calling the CancelShipment method.
For void shipment requests while your application is undergoing testing and integration, you will have to set the Server to: https://wwwcie.ups.com/ups.app/xml/Void.
Once your application is in production, the Server should be sent to the URL provided as part of the certification process.
The MasterTrackingNumber parameter identifies the shipment that contains all packages to be deleted from shipping log.
To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.
Config Method (Upsshipintl 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.
GetShipmentLabels Method (Upsshipintl Class)
Generates a shipping label.
Syntax
public void getShipmentLabels();
Remarks
When this method is called, the following properties must have been set:
- Server (required)
- AccessKey (required)
- Password (required)
- UserId (required)
- AccountNumber (required)
- ServiceType (required)
- AccountContact (conditional)
- AccountAddress (conditional)
- SenderContact (required)
- SenderAddress (required)
- RecipientContact (required)
- RecipientAddress (required)
- SoldToContact (conditional)
- SoldToAddress (conditional)
- Payor (required)
- ShipmentSpecialServices (optional)
- ShipmentDescription (conditional)
- ShipmentReference (conditional)
- Packages (required)
- LabelImageType (required)
- Notify (optional)
- FormTypes (optional)
- CommercialInvoice (optional)
- Commodities (conditional)
- CODReportFile (optional)
- CODTotalAmount (optional)
- CODType (optional)
- WeightUnit (required; defaults to LB)
- Documents (optional)
The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the Commodities (required, regardless of the Documents value).
Upon successful response, the following fields might be populated:
- MasterTrackingNumber (if MPS)
- TrackingNumber for each package included in the shipment;
- ShippingLabel for each package included in the shipment;
- TotalSurcharges for each package included in the shipment (only guaranteed to be returned for shipments whose origin country is US or Puerto Rico);
- TotalNetCharge (applicable to the whole shipment);
- TotalBaseCharge (applicable to the whole shipment);
- TotalSurcharges (applicable to the whole shipment);
Reset Method (Upsshipintl 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.
SchedulePickup Method (Upsshipintl Class)
Schedules a pickup.
Syntax
public String schedulePickup();
Remarks
When called, this will request an OnCall Pickup from UPS and return the Pickup Confirmation Number.
The valid properties when calling this method are as follows:
- PickupEarliestTime (Required)
- PickupLatestTime (Required)
- FirstName (Optional, required if Company is not provided)
- LastName (Optional, required if Company is not provided)
- Company (Optional, required if FirstName and/or LastName are not provided)
- Phone (Required)
- Address1 (Required)
- PickupFloorNumber (Optional)
- PickupRoomNumber (Optional)
- City (Required)
- State (Required, optional if outside US and Canada)
- ZipCode (Required)
- CountryCode (Required)
- ShipDate (Required)
Please note that only Address1 is valid as the request only allows one address line.
Error Event (Upsshipintl Class)
Information about errors during data delivery.
Syntax
public class DefaultUpsshipintlEventListener implements UpsshipintlEventListener { ... public void error(UpsshipintlErrorEvent e) {} ... } public class UpsshipintlErrorEvent { 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 (Upsshipintl Class)
Notification returned by the server upon successful request (if applicable).
Syntax
public class DefaultUpsshipintlEventListener implements UpsshipintlEventListener { ... public void notification(UpsshipintlNotificationEvent e) {} ... } public class UpsshipintlNotificationEvent { 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 (Upsshipintl Class)
Fired after the server presents its certificate to the client.
Syntax
public class DefaultUpsshipintlEventListener implements UpsshipintlEventListener { ... public void SSLServerAuthentication(UpsshipintlSSLServerAuthenticationEvent e) {} ... } public class UpsshipintlSSLServerAuthenticationEvent { 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 (Upsshipintl Class)
Shows the progress of the secure connection.
Syntax
public class DefaultUpsshipintlEventListener implements UpsshipintlEventListener { ... public void SSLStatus(UpsshipintlSSLStatusEvent e) {} ... } public class UpsshipintlSSLStatusEvent { 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.
CommercialInvoiceDetail Type
Represents the commercial invoice (CI) information.
Remarks
This type contains descriptive data identifying the commercial invoice (CI) associating an international shipment that contains non-documents items.
Example: Setting the fields
CommercialInvoiceDetail ci = new CommercialInvoiceDetail
ci.Comments = "Anything"
ci.FreightCharge = "100.00"
ci.Insurance = "1000.00"
ci.Purpose = CIP_SAMPLE
ci.Terms = CIT_FOB_OR_FCA
The fields contained by this type are listed below.
Fields
Comments String |
Commercial Invoice comments to be uploaded to customs. This can be any extra information about the current shipment and is optional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Date String |
Date when the Invoice is created. This is optional for Partial Invoice, but required for Invoice form for forward shipments. For shipment with return service, the user input will be ignored, and the field will be blank on the invoice. If not set, it will default to the ship date. Format is YYYYMMDD. NOTE: This field is only valid for UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FreightCharge String |
Cost to transport the shipment. This is required if Terms is set to Cfr, Cpt, Cif, or Cip. This charge will be added to the total customs value amount. Format: Two explicit decimal positions. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Insurance String |
The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. This is required if Terms is set to Cif or Cip.. This charge will be added to the total customs value amount. Format: Two explicit decimal positions. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Number String |
Customer's assigned invoice number. This is optional. If included in the request, this element prints on the shipping label and commercial invoice. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Purpose int |
Reason to export the current international shipment Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Terms int |
Indicates the rights to the seller from the buyer. Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment. Valid values are:
|
Constructors
public CommercialInvoiceDetail();
public CommercialInvoiceDetail( comments, freightCharge, insurance, purpose, number, terms);
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();
NotifyDetail Type
Represents a single recipient to be notified via email.
Remarks
This type contains specific information about a recipient to be notified via email on shipment, exception and/or delivery status.
In FedEx, this type is also used to specify recipients of Signature Proof of Delivery (SPOD) via fax.
The fields contained by this type are listed below.
Fields
Aggregate String |
This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices. FedEx For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment. The format of this aggregate should be as follows:
In this aggregate, you can specify:
This setting is optional. If Aggregate is not set it will be automatically created by the class. UPS For UPS, the following format is valid:
In this aggregate, you can specify:
Note that this field does not apply for USPS and CanadaPost. |
||||||||||||||||||||||||||
Email String |
Email address of the recipient to be notified. This is required to be provided for each recipient. |
||||||||||||||||||||||||||
Fax String |
Fax number of the recipient that is going to receive the Signature Proof of Delivery via fax. When the FaxProofOfDelivery method is called, the Fax is required. In this case, the Name should be provided as well. Note this is only used by FedEx. |
||||||||||||||||||||||||||
Message String |
User defined text that will be included in the email to be sent to Email. This is optional. For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email. This field is not used by USPS or Canada Post. |
||||||||||||||||||||||||||
Name String |
The name associated with the notification. For FedEx, this is the name of the recipient that is going to receive the Signature Proof of Delivery via fax. When the FaxProofOfDelivery method is called, the Name is required. In this case, the Fax should be provided as well. For USPS, this name will appear in the text of the Signature Confirmation e-mail message. This field is not applicable to UPS or Canada Post. |
||||||||||||||||||||||||||
NotificationFlags int |
Identifies the type of notification requested. Valid values are:
For FedEx notifications, the following flags apply:
For UPS notifications, the following flags apply:
For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply. This field is not used by USPS. |
||||||||||||||||||||||||||
RecipientType int |
Identifies the set of valid email notification recipient types. Valid values are:
For FedEx, when rtShipper, rtRecipient or rtBroker are set, the email address associated with their definitions will be used and the Email specified for these types will be ignored. For USPS, only the rtShipper and rtRecipient are valid. This field does not apply to UPS or Canada Post notifications. |
Constructors
public NotifyDetail();
public NotifyDetail( notificationFlags, email, message);
public NotifyDetail( notificationFlags, email);
public NotifyDetail( notificationFlags, recipientType, email);
public NotifyDetail( name, fax);
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);
PayorDetail Type
Represents the payor details responsible for payment.
Remarks
This type contains data of the responsible party for payment of shipping charges, or duties and taxes. This is used in a ship request.
Example: Setting the fields
PayorDetail payor = new PayorDetail
payor.Type = PT_RECIPIENT
payor.AccountNumber = "123456789"
payor.CountryCode = "US"
The fields contained by this type are listed below.
Fields
AccountNumber String |
The account number of the party responsible for payment (shipping charges, or duties and taxes). This is required to be provided in the ship request, only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to AccountNumber. |
||||||||||
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. Combination of Address1 and Address2 should not exceed 35 characters. |
||||||||||
Address2 String |
A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. Combination of Address1 and Address2 should not exceed 35 characters. |
||||||||||
City String |
Name of city, town, etc. |
||||||||||
CountryCode String |
The country code for the payor of the shipment, or duties and taxes. When shipping via FedEx Express, the CountryCode is required to be provided in the ship request only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the CountryCode is required only if PayorType is set to 'THIRDPARTY'. For UPS, this should be the same as it was entered in the UPS system when this account was set up. In domestic shipments, it will always default to US. |
||||||||||
Name String |
Identifies the payor's name. Name is required only if PayorType is set to 'THIRDPARTY'. Note: This field is only applicable to UPSFreightRates and UPSFreightShip. |
||||||||||
PayorType int |
Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:
The COLLECT payment type is only supported in FedEx Ground services. The CONSIGNEE type is only supported in UPS service. For FedEx, when this field is set to a value other than 0 (ptSender), the AccountNumber and CountryCode are required to be provided in the request as well. Otherwise, those will default to AccountNumber and CountryCode. For UPS, when set to ptSender, the AccountNumber is automatically set to AccountNumber. When ptRecipient is specified, AccountNumber and ZipCode are required to be provided in the request. For return international shipments, this option is invalid for transportation charges. And, when ptThirdParty has been specified, the AccountNumber, ZipCode and CountryCode are required to be provided in the request. When ptConsignee is specified, it indicates that UPS Consignee Billing option is selected, no other fields need to be set. ptConsignee only applies to US/PR and PR/US shipment origins and destination. |
||||||||||
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 |
Payor's postal code (if applicable). This is only applicable to UPS and is the corresponding postal code of the UPS AccountNumber's pickup address. This should be the same as it was entered in the UPS system when this account was set up. It can be provided in a ship request only if the PayorType is set to 1 (RECIPIENT) or 2 (THIRDPARTY). Maximum length: 10. |
Constructors
public PayorDetail();
public PayorDetail( payorType, accountNumber, countryCode);
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);
SEDDetail Type
Represents specific information of Shipper's Export Declaration (SED).
Remarks
This type contains descriptive data identifying the Shipper's Export Declaration (SED) associating an international shipment that contains non-documents items. This is used in the UPSShipIntl class only. It is applicable only if the Shipper's Export Declaration flag of the FormTypes is set.
Example: Setting the fields
SEDDetail sed = new SEDDetail
sed.FiledByUPS = false
sed.PointOfOrigin = "NJ"
sed.InBondCode = "36"
sed.TransportType = "Air"
The fields contained by this type are listed below.
Fields
ECCNNumber String |
Export Control Classification Number. This number identifies categories, product groups, strategic level of control, and country groups. Some products have an ECCN number. This is required for SED forms only when the ExceptionCode is set to one of the following values: CIV, CTP, ENC, KMI, LVS. Required length: 8 characters. |
||||||||||||||||||||||||||||||||||||||||
EntryNumber String |
The Import Entry Number when the export transaction is used as proof of export for import transactions (examples: In Bond, Temporary Import Bond or Drawbacks). This is required for SED forms only if the InBondCode is set to a value other than 0 (ibcNotInBond). Maximum length: 25. |
||||||||||||||||||||||||||||||||||||||||
ExceptionCode int |
License exception code. If this is set to 0 (ecUnspecified), then the LicenseNumber and the LicenseDate are required to be provided in the request. LicenseNumber and ExceptionCode are mutually exclusive. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||
FiledByUPS boolean |
Indicates whether or not UPS will file SED on shipper's behalf. This is required when SED is requested (i.e., when the Shipper's Export Declaration flag of the FormTypes is set). If False (default value), it indicates that SED will be filed by the shipper, not UPS. If True, it indicates that UPS will file SED on shipper's behalf. |
||||||||||||||||||||||||||||||||||||||||
InBondCode int |
Indicates whether the shipment is being transported under bond. This is required when SED form is requested (i.e., when the Shipper's Export Declaration flag of the FormTypes is set). Valid values are:
When InBondCode is set to a value other than ibcNotInBond, the EntryNumber is required to be provided in the request. |
||||||||||||||||||||||||||||||||||||||||
LicenseDate String |
License date. This is required for SED forms only if the LicenseNumber is provided in the request. Format: YYYYMMDD |
||||||||||||||||||||||||||||||||||||||||
LicenseNumber String |
The license number that authorizes ship product. This is required for SED forms only if the ExceptionCode is not provided in the request. LicenseNumber and ExceptionCode are mutually exclusive. If the product is not licensable, a valid ExceptionCode needs to be entered. If shipping different products that are covered under different licenses or license exceptions, then separate SEDs must be created. Maximum length: 35. |
||||||||||||||||||||||||||||||||||||||||
PointOfOrigin String |
Indicates the state or zone number from where the exports are leaving. This is required when SED is requested (i.e., when the Shipper's Export Declaration flag of the FormTypes is set). This should contain one of the following:
Maximum length: 5. |
||||||||||||||||||||||||||||||||||||||||
ShipperTaxId String |
Shipper's Tax Identification Number. This is required for SED forms only. Maximum length: 15 characters. |
||||||||||||||||||||||||||||||||||||||||
TransportType String |
Indicates the type of transport by which the goods are exported. This is required when SED is requested (i.e., when the Shipper's Export Declaration flag of the FormTypes is set). Possible values: Air, AirContainerized, Auto FixedTransportInstallations Mail, PassengerHandcarried Pedestrian, Rail, RailContainerized, RoadOther, SeaBarge, SeaContainerized SeaNoncontainerized, Truck, TruckContainerized. |
Constructors
public SEDDetail();
public SEDDetail( filedByUPS, pointOfOrigin, transportType, inBondCode, entryNumber, licenseNumber, licenseDate, shipperTaxId);
public SEDDetail( filedByUPS, pointOfOrigin, transportType, inBondCode, licenseNumber, licenseDate, shipperTaxId);
public SEDDetail( filedByUPS, pointOfOrigin, transportType, inBondCode, entryNumber, exceptionCode, ECCNNumber, shipperTaxId);
public SEDDetail( filedByUPS, pointOfOrigin, transportType, inBondCode, exceptionCode, ECCNNumber, shipperTaxId);
public SEDDetail( filedByUPS, pointOfOrigin, transportType, inBondCode, exceptionCode, shipperTaxId);
UPSAccount Type
Represents the details of a UPS account.
Remarks
This type contains data describing the UPS server and login information.
Example: Setting the fields of an account
UPSAccount account = new UPSAccount
account.Server = "https://wwwcie.ups.com/";
account.AccessKey = "123451234512345";
account.AccountNumber = "12345";
account.Password = "my_password";
account.UserId = "my_username";
The fields contained by this type are listed below.
Fields
AccessKey String |
An identifier required to connect to a UPS server. A UserId, Password and AccessKey will be required for each request sent to UPS. This Access Key is provided to you by UPS. For this, please visit http://www.ups.com/e_comm_access/gettools_index?loc=en_US and follow the steps as instructed on that page. Please read the instructions carefully. You should register first, and after reviewing and accepting the UPS User Agreement, you should submit a request for an UPS OnLine Tools Developer's Key. After the request has been submitted, your Developer's Key will be emailed to the email address you provided to UPS during registration process. After obtaining the Developer's Key, you can then submit a request for the Access License Key (for XML tools). This will also be sent to you via email. Please save it as it is required to be used with all requests sent to any UPS server (via our class which utilizes UPS Online Tools). An Access Key provides access to UPS systems, which hold the information you or your customers need to ship, track, or rate a package. Your Developer's Key lets you get UPS OnLine Tool documentation; the Access Key lets you actually implement UPS OnLine Tools. You need only one Access Key for access to all UPS OnLine Tools. However, if multiple locations or departments will be accessing the Tools, a great way to monitor and assess usage is to have an Access Key per location. UPS recommends each site implementation of your EC (E-Commerce) solution have separate Access Keys. An example would be a company that is implementing the Tools into three parts of their organization in three different cities. In this case, it is recommended that you obtain three separate Access Keys to uniquely identify each site. If you have Production access for an API, you can still access the Test environment. If you have Test access for one or more APIs, you must Request Production Access in order to use those APIs for production requests. This 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. Sharing the security elements (UserId, Password, AccessKey, and DeveloperKey) with third parties is strictly prohibited as expressed in the UPS Developer Agreement. |
||||||||||||||||||||||||||||||||||||
AccountNumber String |
The shipper's UPS account number. This field describes the shipper's 6- or 10- digit UPS account number. |
||||||||||||||||||||||||||||||||||||
Password String |
Password to use for logging in to a UPS Server. A UserId and Password will be required with each input request a user makes to a UPS server. These are used to authenticate the client system during login. This password is the one you chose to login when you registered for service with UPS. This 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. Sharing the security elements (UserId, Password, AccessKey, and DeveloperKey) with third parties is strictly prohibited as expressed in the UPS Developer Agreement. Number of characters: 6..10. |
||||||||||||||||||||||||||||||||||||
Server String |
URL for the UPS server where the requests are sent. Each request requires specific processing based on the type; therefore, each component has a unique URL for connection purposes. The following URLs may be used for testing:
In a production environment, the URL for connecting to a UPS server (production environment) will be provided to you by UPS when you subscribe for UPS OnLine Tools. |
||||||||||||||||||||||||||||||||||||
UserId String |
User Id for logging in to UPS. A UserId and Password will be required with each request made to UPS. These are used to authenticate the client system during login. The UserId is the one you chose to login with when you registered for service with UPS. This 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. Sharing the security elements (UserId, Password, AccessKey, and DeveloperKey) with third parties is strictly prohibited as expressed in the UPS Developer Agreement. Maximum length: 16. |
Constructors
public UPSAccount();
Config Settings (Upsshipintl 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.UPSShipIntl Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AccountAddress3: Contains line three details for the Account Address.This property is used to set specific details which will appear in line three of the Account Address. This is usually department information. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AccountTaxId: The Tax ID Number for the account holder.This specifies the Tax ID Number (TIN) for the account holder. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AccountTotalNetCharge: Net sum of negotiated rates applied to the whole shipment (if applicable).This indicates the account-based rates. It is applicable and returned in the ship response only if shipper account/user id combinations qualifies for Negotiated rates. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AdditionalDocumentIndicator:
Indicates that additional documents will be supplied.This indicator should be set when the shipper intends to utilize UPS paperless invoice functionality and
the shipper has self-prepared other International Forms (SEC, CO, NAFTACO) to accompany the shipment.
Note that this is only applicable if your account is enabled to use the Paperless Invoice functionality. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AlternateDeliveryAddress:
Used to specify an XML or SOAP aggregate for Hold for Pickup or Delivery at UPS Access Points.The specified aggregate will be contained within the "AlternateDeliveryAddress" element of the request.
Sample SOAP aggregate when UseSOAP configuration setting is set to True:
Sample XML aggregate when UseSOAP configuration setting is set to False:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BarCodeReference:
Determines whether the reference number's value will be bar coded on the shipping label.If True, then the reference number's value (first value of the ShipmentReference in the UPSShipIntl class, or
first value of the Reference in the UPSShip class) will be bar coded on the shipping label.
Only one shipment-level (applicable to international shipments) or package-level reference number (applicable to domestic shipments throughout US or PR) can be bar coded per shipment. In order to barcode a reference number, its value must be no longer than 14 alphanumeric characters or 24 numeric characters and cannot contain spaces. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CertifyDirectory:
The name of the directory where the files needed for Label Certification are written.To be used in Label Certification process only.
If this config is set to a valid value, all files needed for certification process (html, gif and xml files) are written to disk in this specified location. Note: When this is set, all shipping label filenames will be overwritten with the format required by UPS for the Certification process. For example, if the PackageShippingLabelFileHTML[i]; is set to 'MyShippingLabel.html' and the ShippingLabelFile is set to and the Tracking Number for that package is '1Z0715X10194877288', then the PackageShippingLabelFileHTML[i]; will automatically be changed to 'label1Z0715X10194877288.html', and the corresponding image file name to 'label1Z0715X10194877288.gif'. If both ShippingLabelHTMLDirectory and CertifyDirectory have been set, then the CertifyDirectory will take precedence over the ShippingLabelHTMLDirectory. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CIPONumber: Purchase Order Number for Commercial Invoice.This configuration setting adds a Purchase Order Number on the generated Commercial Invoice. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CN22CountryOfOrigin: Country of origin from where the CN22 contents originated.This setting populates the CN22ContentCountryOfOrigin element of the CN22 Form. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CN22FoldHereText: Will replace default 'Fold Here' text displayed on the label.This setting populates the text for the 'Fold Here' line, if present on the label. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CN22OtherDescription:
Description of the type if CN22Type is 'OTHER'.This setting is required if the CN22Type setting is set to 4 (OTHER).
Note: maximum length for this setting is 20 characters. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CN22Quantity: Total number of items associated with this content.This setting determines the total number of items associated with the content for the CN22 Form. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CN22TariffNumber:
The tariff number associated with the CN22 contents.This setting determines the tariff number associated with the CN22 contents.
Note: maximum length for this setting is 20 characters. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CN22Type:
The type of CN22 form to be used.The type of CN22 form to be used. Legal values are:
* - Requires the use of the CN22OtherDescription setting. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CurrencyCode:
The currency code associated with the monetary values present in the request.This is required to be provided if monetary values are specified in the request (such as COD amount,
insured value, customs value, etc.). This must conform to ISO standards.
Maximum length: 3. Here is a list of currency names and their codes used by UPS services.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DeclarationStatement:
The declarations statement to be sent to the customs office.This is the legal explanation, used by Customs, for the delivering of this shipment. It must be identical to the set of
declarations actually used by Customs. Examples of declarations that might be entered in this field are:
I hereby certify that the goods covered by this shipment qualify as originating goods for purposes of preferential tariff
treatment under the NAFTA.I hereby certify that the information on this invoice is true and correct and the contents and
value of this shipment is as stated above. EEA statement: The exporter of the products covered by this document declares
that except where otherwise clearly indicated these products are of EEA preferential origin.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documents:
Whether an international shipment contains documents of no commercial value.It is valid only for shipments with different origin and destination countries.
The origin country is not US, and the destination country is not CA, PR or MX.
If False (default value), it implies that the shipment contains non documents or documents of commercial value. In this case, the data for commodity items (included in the shipment) have to be provided in the request. The Commercial Invoice is required to associate the shipment (see respective commodity elements defined by the Commodities for more details). If True, it indicates a shipment contains written, typed, or printed communication of no commercial value. An international shipment can either contain documents only, or no documents. Documents and other commodities cannot be mixed in a shipment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EEIFilingXML:
The XML for EEIFilingOption.
Use this configuration setting to display the PreDepartureITNNumber or the EEIShipmentReferenceNumber on an international label when filing through AESDirect. Below are two examples. PreDepartureITNNumber:ship.Config(@"EEIFilingXML=<EEIFilingOption>
<Code>2</Code>
<ShipperFiled>
<Code>A</Code>
<PreDepartureITNNumber>X20120428123456</PreDepartureITNNumber>
</ShipperFiled>
</EEIFilingOption>");
EEIShipmentReferenceNumber:
ship.Config(@"EEIFilingXML=<EEIFilingOption>
<Code>2</Code>
<ShipperFiled>
<Code>C</Code>
<EEIShipmentReferenceNumber>1234567890</EEIShipmentReferenceNumber>
</ShipperFiled>
</EEIFilingOption>");
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ElectronicReturnLabel:
Indicates that you are arranging for UPS to email a return label to your customer.Indicates that the ship request is made for UPS Print and Mail (PNM). This is applicable to return shipments only.
In the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.
The label will be emailed to your customer by UPS.
If this is set, either SenderContactEmail or AccountContactEmail, as well as RecipientContactEmail should be set. For return shipments, one of the following conditions must be met on CountryCode, CountryCode and CountryCode: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for FormTypes. The availability of return service depends on the origin and destination country code, and on the selected ServiceType. The Description is required to be provided in the request for each package contained in the shipment. The PackagingType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only. This is false by default. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EPRAReleaseCode:
Package Release code that allows the consignee or claimant to pick-up a package at a UPS Access Point.The shipper must proivde the Package Release Code to the consignee so that they can provide the code to the UPS Access Point personnel as another item for authentication before the package is released to them. It must be between 4-6 characters.
This configuration setting is only valid when ShipmentIndicationType is set to 1. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExportDate: The date the goods will be exiting the country.Applicable and required if SED and/or CO forms are requested (i.e., when the FormTypes flag is set to SED and/or CO). If not set, it will default to ship date. Format: YYYYMMDD. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExportingCarrier:
The name of the carrier that is exporting the shipment.If the carrier is a vessel, the vessel's flag number should also be entered.
Applicable and required if SED and/or CO forms are requested (i.e., when the FormTypes flag is set to SED
or CO).
Maximum length: 17. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FRSCommodityCount:
Number of commodities in the shipment.This configuration property is used to specify the number of commodities for the
freight rated shipment.
This configuration option is only valid when ReturnFreightPrices is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FRSCommodityFreightClass[i]:
The freight class of the commodity at the index.This configuration property indicates the freight class of the commodity.
The following table lists freight classes available from UPS freight services.
Valid indices are from 0 to FRSCommodityCount - 1. This configuration option is only valid when ReturnFreightPrices is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FRSCommodityFreightNMFC[i]:
The National Motor Freight Classification numbers for the commodity at the index.This configuration property identifies the National Motor Freight Classification numbers.
Valid indices are from 0 to FRSCommodityCount - 1. This configuration option is only valid when ReturnFreightPrices is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FRSCommodityFreightNMFCSub[i]:
The sub-code of National Motor Freight Classification numbers for the commodity at the index.This configuration property identifies the sub code of National Motor Freight Classification numbers.
Valid indices are from 0 to FRSCommodityCount - 1. This configuration option is only valid when ReturnFreightPrices is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FRSPaymentAccountNumber:
The UPS account number for the payor.This configuration options should be set to the UPS Account Number of the
payor for Ground Freight Pricing. This account number is validated to ensure
that Ground Freight Pricing is enabled for the account.
This configuration option is only valid when ReturnFreightPrices is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FRSPaymentCountryCode:
The country code of the payor for the Ground Freight Pricing shipment.If FRSPaymentType is set to "2" for "Prepaid (Third Party) then
the country code for the third party payor must be specified.
This configuration option is only valid when ReturnFreightPrices is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FRSPaymentDescription:
Description for the Ground Freight Pricing payment type.This configuration option is used to specify a description for the
Ground Freight Pricing payment type, for example the paying party's name.
This configuration option is only valid when ReturnFreightPrices is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FRSPaymentPostalCode:
The postal code of the payor for the Ground Freight Pricing shipment.If FRSPaymentType is set to "2" for "Prepaid (Third Party) then
the postal code for the third party payor must be specified.
This configuration option is only valid when ReturnFreightPrices is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FRSPaymentType:
Method of payment for the shipment.This configuration property is used to specify the method of payment for the freight
rated shipment. Valid options are:
This configuration option is only valid when ReturnFreightPrices is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatAdditionalDescription[i]:
Additional remarks or special provision information.Additional remarks or special provision information. Required if HazMatCommodityRegulatedLevelCode = LQ or FR and if the field applies
to the material by regulation. Additional information that may be required by regulation about a hazardous material,
such as, "Limited Quantity", DOT-SP numbers, EX numbers.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMataDRItemNumber[i]:
The type of regulated goods for an ADR package where ADR is for Europe to Europe ground movement.The type of regulated goods for an ADR package where ADR is for Europe to Europe ground movement.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMataDRPackingGroupLetter[i]:
Required if the field applies to the material by regulation. Must be shown in Roman Numerals.Required if the field applies to the material by regulation. Must be shown in Roman Numerals.
Valid values: 1 - I, 2 = II, 3 = III, and blank.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatAllPackedInOneIndicator[i]:
Presence/Absence Indicator.Presence/Absence Indicator. When set to true, indicates if multiple, different hazmat/chemicals are contained within one box in a package.
When number of Hazmat containers in a package is more than one either HazMatAllPackedInOneIndicator or HazMatOverPackedIndicator is needed.
The default value for this setting is false.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatChemicalRecordIdentifier[i]:
Identifies the Chemcial Record.Required if SubVersion is greater than or equal to 1701.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatClassDivisionNumber[i]:
This is the hazard class associated to the specified commodity.This is the hazard class associated to the specified commodity. Required if HazMatCommodityRegulatedLevelCode is 'EQ', 'LQ' or 'FR'
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatCommodityRegulatedLevelCode[i]:
Indicates the type of commodity.Indicates the type of commodity. Required for subversion 1701 or greater.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatEmergencyContact[i]:
The emergency information, contact name and/or contract number.The emergency information, contact name and/or contract number, required to be communicated when a call is placed
to the HazMatEmergencyPhone. The information is required if there is a value in the HazMatEmergencyPhone
field above and the shipment is with a US50 or PR origin and/or destination and the HazMatRegulationSet is IATA.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatEmergencyPhone[i]:
24 Hour Emergency Phone Number of the shipper.24 Hour Emergency Phone Number of the shipper. Valid values for this field are (0) through (9) with trailing blanks.
For numbers within the U.S., the layout is '1', area code, 7-digit number. For all other countries the layout is
country code, area code, number.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatHazardLabelRequired[i]:
Defines the type of label that is required on the package for the commodity.Defines the type of label that is required on the package for the commodity. Not applicable if HazMatCommodityRegulatedLevelCode = LR or EQ.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatIDNumber[i]:
This is the ID number (UN/NA/ID) for the specified commodity.This is the ID number (UN/NA/ID) for the specified commodity. Required if HazMatCommodityRegulatedLevelCode = LR, LQ or FR and if the field applies
to the material by regulation. UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry).
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatOverPackedIndicator[i]:
Presence/Absence Indicator.Presence/Absence Indicator. When set to true, indicates that one or more hazmat/chemicals are in separate boxes in a package.
When number of Hazmat containers in a package is more than one either HazMatAllPackedInOneIndicator or HazMatOverPackedIndicator is needed.
The default value for this setting is false.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatPackageIdentifier[i]:
Identifies the package containing Dangerous Goods.Required for Hazmat shipment if SubVersion is greater than or equal to 1701.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatPackagingGroupType[i]:
This is the packing group category associated to the specified commodity.This is the packing group category associated to the specified commodity. Required if HazMatCommodityRegulatedLevelCode = LQ or FR and
if the field applies to the material by regulation. Must be shown in Roman Numerals. Valid values: I, II, III, blank.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatPackagingInstructionCode[i]:
The packing instructions related to the chemical record.The packing instructions related to the chemical record. Required if HazMatCommodityRegulatedLevelCode = LQ or FR
and if the field applies to the material by regulation.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatPackagingType[i]:
The type of package used to contain the regulated good.The type of package used to contain the regulated good. (Ex: Fiberboard Box). Required if HazMatCommodityRegulatedLevelCode = LQ or FR.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatPackagingTypeQuantity[i]:
The number of pieces of the specific commodity.The number of pieces of the specific commodity. Valid values are 1 to 999.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatProperShippingName[i]:
The Proper Shipping Name assigned by ADR, CFR or IATA.The Proper Shipping Name assigned by ADR, CFR or IATA.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatQuantity[i]:
.Required if HazMatCommodityRegulatedLevelCode = EQ, LQ or FR. The numerical value of the mass capacity of the regulated good.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatQValue[i]:
.When a HazMat shipment specifies AllPackedInOneIndicator and the regulation set for that shipment is IATA, Ship API must require the
shipment to specify a Q-Value with exactly one of the following values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatReferenceNumber[i]:
Optional reference number. Will be displayed only on label.Optional reference number. Will be displayed only on label.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatRegulationSet[i]:
The Regulatory set associated with every regulated shipment.The Regulatory Set associated with every regulated shipment. It must be the same across the shipment.
Valid values are: ADR = Europe to Europe Ground Movement, CFR = HazMat regulated by US Dept of Transportation
within the U.S. or ground shipments to Canada, IATA= Worldwide Air movement, TDG= Canada to Canada ground
movement or Canada to U.S. standard movement.
For multiple ChemicalRecords per package or multiple packages containing different RegulationSet, RegulationSet of first ChemicalRecord would be considered for validating and rating the entire shipment. This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatReportableQuantity[i]:
.Recommonded if HazMatCommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.
If reportable quantity is met, 'RQ' should be entered.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatSubRiskClass[i]:
Secondary hazardous characteristics of a package.Secondary hazardous characteristics of a package. (There can be more than one - separate each with a comma). Recommended if
HazMatCommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatTechnicalName[i]:
The technical name (when required) for the specified commodity.The technical name (when required) for the specified commodity. Required if HazMatCommodityRegulatedLevelCode = LQ or FR
and if the field applies to the material by regulation.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatTransportationMode[i]:
Declares that a package was prepared according to ground, passenger aircraft, or cargo aircraft only.Not applicable for ADR regulation set. Required for any other regulation set. Declares that a package was prepared according
to ground, passenger aircraft, or cargo aircraft only.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatTransportCategory[i]:
Transport Category.This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1
SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatTunnelRestrictionCode[i]:
.Defines what is restricted to pass through a tunnel.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HazMatUOM[i]:
.Required if HazMatCommodityRegulatedLevelCode = LQ, EQ or FR. The unit of measure used for the mass capacity of the regulated good.
For Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc.
This setting is only applicable when using UPS. Valid array indices are from 0 to Packages.Count - 1 SubVersion must be set to a value equal or greater than 1701 for shipping Dangerous Goods with UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HighValueReport:
High Value Report (if applicable).Image of the High Value Report (as decoded binary image file). When the total insured value in a forward shipment is between
$999 and $50,000 USD, the High Value Report is returned in the response and stored in HighValueReport.
The shipper is required to print 2 copies of this report, give them to a UPS driver or UPS Customer Center representative to ensure he signs one copy of the receipt and returns it to the shipper. This is your proof that UPS has accepted the package(s), and will be required for submitting a claim. When the HighValueReportFileName is set to a valid path and filename, the contents of the HighValueReport are written to this location in disk. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HighValueReportFileName:
Name of High Value Report (if applicable).Filename and location to save the HighValueReport to. When the total insured value in a forward shipment
is between $999 and $50,000 USD, the High Value Report is returned in the response and stored in HighValueReport.
The shipper is required to print 2 copies of this report, give them to a UPS driver or UPS Customer Center representative to ensure he signs one copy of the receipt and returns it to the shipper. This is your proof that UPS has accepted the package(s), and will be required for submitting a claim. When the HighValueReportFileName is set to a valid path and filename, the contents of the HighValueReport are written to disk upon successful response. This filename should have a html, EPL2, ZPL, STARPL or SPL extension (depending on the printer used). If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ImportControlCode:
Code for type of ImportControl label.This code indicates the type of ImportControl/LabelMethod label in a Shipping or Rating request.
Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ImportControlDescription: Description for ImportControl.When set, the value will added to the ImportControl/LabelMethod description in a Shipping or Rating request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncludeNegotiatedRates: Whether to include the NegotiatedRatesIndicator in the request.This controls whether the NegotiatedRatesIndicator is sent in the request. When sent UPS will return the negotiated rates for the shipper account. When not sent UPS will return the standard, list rates. The default value is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InvoiceDiscount:
The discount to be subtracted from the total value on the invoice.If set, this will provide the sum of all the discounts to be applied to the invoice.
Note that the maximum length, including the decimal is 15. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IrregularIndicator:
The mail classification defined by UPS.When Machineable is set to false, this should be set to one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ItemizedChargesCode[i]:
The Accesorial/Surcharge code of the itemized charge.The Accesorial/Surcharge code of the itemized charge.
These charges can come back at both the shipment and package level. By default they return the shipment level charges. To access the charges for each package, set PackageServiceIndex first. These charges may only come back if SubVersion is 1607 or greater. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ItemizedChargesCount:
The count of itemized charges.The count of itemized charges in the response.
These charges can come back at both the shipment and package level. By default they return the shipment level charges. To access the charges for each package, set PackageServiceIndex first. Below is an example:
These charges may only come back if SubVersion is 1607 or greater. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ItemizedChargesCurrencyCode[i]:
The currency used for the charge.The currency used for the charge.
These charges can come back at both the shipment and package level. By default they return the shipment level charges. To access the charges for each package, set PackageServiceIndex first. These charges may only come back if SubVersion is 1607 or greater. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ItemizedChargesMonetaryValue[i]:
The amount being charged.The amount of the Accesorial/Surcharge.
These charges can come back at both the shipment and package level. By default they return the shipment level charges. To access the charges for each package, set PackageServiceIndex first. These charges may only come back if SubVersion is 1607 or greater. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ItemizedChargesSubType[i]:
The subtype of the itemized charge.The subtype of the Accesorial/Surcharge.
These charges can come back at both the shipment and package level. By default they return the shipment level charges. To access the charges for each package, set PackageServiceIndex first. These charges may only come back if SubVersion is 1607 or greater. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LabelSize:
The size of the label.This contains the size of the label. The valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Machineable:
Determines whether the package is machineable or not.When set to true (default), this indicates wheter or not the package is machineable, in other words, if it is a standard
sized package.
This only applies when using a Mail Innovations or SurePost ServiceType |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MasterCartonId: Master Carton ID.This setting allows you to retrieve or specify the Master Carton ID. Use this configuration setting to link UPS Worldwide Economy (WWE) shipments into a Master Carton. A MasterCartonId will be returned if MasterCartonIndicator is present in the request of the first child shipment and the ServiceType is set to either stUPSWorldwideEconomyDDP or stUPSWorldwideEconomyDDU. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MasterCartonIndicator: Determines whether to include the MasterCartonIndicator in the request.This controls whether the MasterCartonIndicator is sent in the request. Presence of the indicator implies that shipment is Master Carton type. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MICostCenter:
Customer assigned identifier for report and billing summarization displays to the right of the Cost Center title.This is a customer defined identifier that can later be used to get the report and billing summarization displays to the
right of the Cost Center title. This should be an alpha-numeric string that is between 1 and 30 characters.
This is required when using a Mail Innovations ServiceType (ie. stUPSFirstClass, stUPSPriorityMail, stUPSExpeditedMailInnovations, stUPSPriorityMailInnovations, or stUPSEconomyMailInnovations). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MILabelCN22: Determines whether the MILabelCN22Indicator is included in the request.When true, the MILableCN22Indicator tag is included in the ShipmentConfirmRequest. The setting is false by default. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MIPackageID:
Customer assigned unique piece identifier that returns visibility events.This is a customer defined identifier to identify the individual package that can be used to later get the visibility
events for the package. This should be an alpha-numeric string that is between 1 and 30 characters.
This is required when using a Mail Innovations ServiceType (ie. stUPSFirstClass, stUPSPriorityMail, stUPSExpeditedMailInnovations, stUPSPriorityMailInnovations, or stUPSEconomyMailInnovations). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NAFTAExcludeFromForm[i]: Excludes the commodity from NAFTA form (corresponding to the commodity at index i).If set to true, the commodity specified at index i will be excluded from the NAFTA form. If FormTypes is not set to NAFTA Certificate of Origin (0x00000008), this will be ignored. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NotificationDialect:
Used to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications.Used to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications. The default value is US
Possible Language / Dialect combinations:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NotificationLanguage:
Used to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications.Used to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications. The default value is ENG
Refer to NotificationDialect configuration setting for possible Language / Dialect combinations. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OtherCharges:
The amount of all additional charges.The sum of all other charges not already listed on the invoice. If this is set, OtherChargesDescription
must also be set.
Note that the maximum length, including the decimal is 15. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OtherChargesDescription:
The reason for the other charges.This provides the reason for the charges specified in OtherCharges.
Note that the maximum length is 10. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OverridePaperlessIndicator:
Indicates that a copy of the invoice and NAFTA Certificate of Origin should be provided.If set to true, UPS will return a copy of the invoice and NAFTA Certificate of Origin.
Note that this only applies when using the Paperless Invoice functionality. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageDeclaredValueType[i]:
The type of declared value (corresponding to the package at index i).This determines the type of declared value for a package.
Valid array indices are from 0 to PackageCount - 1. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageShippingLabelFileHTML[i]:
Name of the file where the HTML image of the shipping label (corresponding to the package at index i) is saved to disk.Filename to save the PackageShippingLabelHTML to.
When the user is going through the Label Certification process with UPS, the CertifyDirectory should be set (this is the location where all required files by UPS for Label Certification will be written and then sent to UPS) and the PackageShippingLabelFileHTML will be automatically set to 'labelTrackingNumber.html'. This file is required to be sent to UPS for each of the five test shipments along with the: image file (gif) of that shipment's shipping label (ShippingLabel), ShipmentConfirmRequest, ShipmentConfirmResponse, ShipmentAcceptRequest, and ShipmentAcceptResponse of that shipment. If you are no longer in certification process, the location where this file will be saved to disk can be specified by the ShippingLabelHTMLDirectory. If this config is not set, then the html file will be written to your default directory. If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True). Valid array indices are from 0 to PackageCount - 1. Note: When choosing to save to disk the html file for the shipping label, the image file should be written to disk as well (at the same directory as html file) and the corresponding ShippingLabelFile should be set to 'labelTrackingNumber.gif'. Otherwise, the html file will show just the UPS shipping instructions and the label itself will not appear on it. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PackageShippingLabelHTML[i]:
HTML version of the shipping label (corresponding to the package at index i).HTML image of the package shipping label (as decoded binary image file). This is used during the Label Certification
process with UPS.
When the PackageShippingLabelFileHTML is set to a valid path and filename, the contents of the PackageShippingLabelHTML are written to this location in disk. Valid array indices are from 0 to PackageCount - 1. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PickupEarliestTime:
The earliest time a shipment is ready to be picked up.This is required to be provided in a ship request only if UPS On-Call Pickup service is requested
(i.e., when the corresponding flag for On-Call Pickup (0x01000000) is present in ShipmentSpecialServices).
This should be entered in this format: HHmm. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PickupFloorNumber: The floor number of the pickup location.This setting specifies the floor number of the pickup location. It is applicable when calling SchedulePickup | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PickupLatestTime: The latest time a shipment can be picked up. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PickupRoomNumber: The room number of the pickup location.This setting specifies the room number of the pickup location. It is applicable when calling SchedulePickup | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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: Contains line three details for the Recipient Address.This property is used to set specific details which will appear in line three of the Recipient Address. This is usually department information. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RecipientTaxId: The Tax ID Number for the recipient.This specifies the Tax ID Number (TIN) for the recipient. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RequestDeliveryConfirmation: Whether or not to request delivery confirmation for the package/shipment.When set to false, no delivery confirmation will be requested. However, this will not stop the driver from getting delivery confirmation if they feel they must. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RequestOption:
Defines if the address should be validated or not.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnFreightPrices: When true, UPS will use applicable freight pricing for shipments.When this configuration setting is set to "true", UPS will use freight pricing for any generated labels. The user must have an existing agreement with UPS for freight pricing, such as "UPS Ground with Freight Pricing", in order to use this functionality. When set to "true", FRSCommodityCount, FRSCommodityFreightClass[i];, FRSCommodityFreightNMFC[i];, FRSPaymentType, FRSPaymentDescription, FRSPaymentAccountNumber, FRSPaymentPostalCode, and FRSPaymentCountryCode must be set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnPrintAndMail:
Indicates that you are arranging for UPS to print and mail a return label to your customer.Indicates that the ship request is made for UPS Print and Mail (PNM). This is applicable to return shipments only.
In the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.
The label will be printed and mailed to your customer by UPS.
For return shipments, one of the following conditions must be met on CountryCode, CountryCode and CountryCode: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for FormTypes. The availability of return service depends on the origin and destination country code, and on the selected ServiceType. The Description is required to be provided in the request for each package contained in the shipment. The PackagingType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only. This is false by default. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnServiceFirstAttempt:
Indicates that you are arranging for UPS to make one attempt to pick up the package to be returned.Indicates that the ship request is made for UPS Return Service 1-Attempt (RS1). This is applicable to return shipments only.
UPS will make only one attempt to pick up your package.
If the package cannot be collected, UPS will leave the return label at the pickup location. Note that the service charge will still apply.
In the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.
For return shipments, one of the following conditions must be met on CountryCode, CountryCode and CountryCode: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for FormTypes. The availability of return service depends on the origin and destination country code, and on the selected ServiceType. The Description is required to be provided in the request for each package contained in the shipment. The PackagingType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only. This is false by default. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnServiceThirdAttempt:
Indicates that you are arranging for UPS to make three attempts to pick up the package to be returned.Indicates that the ship request is made for UPS Return Service 3-Attempt (RS3). This is applicable to return shipments only.
UPS will attempt to pick up your package for three consecutive business days.
After the third attempt, the return label will be returned to UPS. Note that the service charge will still apply.
In the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.
For return shipments, one of the following conditions must be met on CountryCode, CountryCode and CountryCode: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for FormTypes. The availability of return service depends on the origin and destination country code, and on the selected ServiceType. The Description is required to be provided in the request for each package contained in the shipment. The PackagingType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only. This is false by default. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnsFlexibleAccessIndicator: Defines if the Returns Flexible Access service should be used.If set to true, Returns Flexible Access service will be used. Note that to use this service you will need to enter into a contract with UPS. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SendDutiesPayor: Indicates whether to send the duties payor information or not.If true (default), the duties payor information will be sent to UPS, otherwise only the payor for the transportation charges will be sent. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SenderAddress3: Contains line three details for the Sender Address.This property is used to set specific details which will appear in line three of the Sender Address. This is usually department information. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SenderTaxId:
The Tax ID Number for the sender.This specifies the Tax ID Number (TIN) for the sender. This is required when using SED forms.
Note that if ShipperTaxId is set, it will override this config. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipmentAcceptRequest:
Contains the Shipment Accept Request sent to UPS.Used in Label Certification process.
This is required to be sent to UPS for each of the five test shipments along with the: .gif image of that shipment's shipping label (ShippingLabel), the html document (PackageShippingLabelHTML[i];), ShipmentConfirmRequest, ShipmentConfirmResponse, and ShipmentAcceptResponse of that shipment. If the CertifyDirectory has been set, then the ShipmentAcceptRequest will be automatically written to disk in xml format under this file name: 'ShipmentAcceptRequest_LabelTrackingNumber.xml'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipmentAcceptResponse:
Contains the Shipment Accept Response returned by UPS.Used in Label Certification process.
This is required to be sent to UPS for each of the five test shipments along with the: .gif image of that shipment's shipping label (ShippingLabel), the html document (PackageShippingLabelHTML[i];), ShipmentConfirmRequest, ShipmentConfirmResponse, and ShipmentAcceptRequest of that shipment. If the CertifyDirectory has been set, then the ShipmentAcceptResponse will be automatically written to disk in xml format under this file name: 'ShipmentAcceptResponse_LabelTrackingNumber.xml'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipmentConfirmRequest:
Contains the Shipment Confirm Request sent to UPS.Used in Label Certification process.
This is required to be sent to UPS for each of the five test shipments along with the: .gif image of that shipment's shipping label (ShippingLabel), the html document (PackageShippingLabelHTML[i];), ShipmentConfirmResponse, ShipmentAcceptRequest, and ShipmentAcceptResponse of that shipment. If the CertifyDirectory has been set, then the ShipmentConfirmRequest will be automatically written to disk in xml format under this file name: 'ShipmentConfirmRequest_LabelTrackingNumber.xml'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipmentConfirmResponse:
Contains the Shipment Confirm Response returned by UPS.Used in Label Certification process.
This is required to be sent to UPS for each of the five test shipments along with the: .gif image of that shipment's shipping label (ShippingLabel), the html document (PackageShippingLabelHTML[i];), ShipmentConfirmRequest, ShipmentAcceptRequest, and ShipmentAcceptResponse of that shipment. If the CertifyDirectory has been set, then the ShipmentConfirmResponse will be automatically written to disk in xml format under this file name: 'ShipmentConfirmResponse_LabelTrackingNumber.xml'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipmentDescription: A textual description of goods for the whole shipment when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments.This is applicable and required when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments. Provide a detailed description of items being shipped for documents and non-documents, such as 'annual reports', '9 mm steel screws', etc.. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipmentIndicationType:
Whether shipment is Hold For Pickup or Delivery at UPS Access Points.Required to indicate whether shipment is Hold For Pickup at UPS Access Point for use by approved shippers to identify a UPS Access Point location as an alternate delivery option during shipment preparation or UPS Access Point Delivery, to ship parcels directly to a UPS Access Point location for collection by the receiver.
This configuration setting is required when sending an alternate delivery address via the AlternateDeliveryAddress configuration setting. Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShipmentSignatureType:
Shipment signature type at the shipment level.Specifies one of the Delivery Signature Options requested for this shipment. Possible values are:
Note for package level signature types the SignatureType field must be set. The default value for this configuration setting is 0. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ShippingLabelHTMLDirectory:
The name of the directory where the shipping label files are written.This is used when the html files of shipping labels are needed.
If this config is set to a valid value, then all shipping labels files (html and gif) are automatically written to disk in this specified location. Note: When this is set, then the image file (gif) will automatically be written to disk (even if the ShippingLabelFile has not been set) along with the html file of the corresponding shipping label (html file serves as a wrapper for the image file). In this case, the name for the image file will automatically be set to 'labelTrackingNumber.gif'. This will overwrite any values already being set to this config by the user. If the corresponding PackageShippingLabelFileHTML[i]; is not set, then the class will name the html file(s) for you in this format: 'labelTrackingNumber.html'. Otherwise, the name chosen by the user will be used. If the ShippingLabelHTMLDirectory is empty and the PackageShippingLabelFileHTML[i]; is set, then the html file will be written to your default directory. Please note that when using html file for the shipping label, the image file should be written to disk as well (at the same directory as html file) and it should be named in this format 'labelTrackingNumber.gif'. Otherwise, the html file will show just the UPS shipping instructions and the label itself will not appear on it. If both ShippingLabelHTMLDirectory and CertifyDirectory have been set, then the CertifyDirectory will take precedence over the ShippingLabelHTMLDirectory. This is required to be provided in a ship request only if UPS On-Call Pickup service is requested (i.e., when the corresponding flag for On-Call Pickup (0x01000000) is present in ShipmentSpecialServices). It can be also referred as the Closing Time for a pickup time window. This should be entered in this format: HHmm. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SoldToTaxId: The Tax ID Number for the person or business the product was sold to.This specifies the Tax ID Number (TIN) for the person or business the product was sold to. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SplitDutyVATIndicator: Indicates that whether or not the duties and taxes are split.If true, the payor paying the transportation charges will also pay the duties and the payor who is paying the duties and taxes only pays the taxes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SubVersion:
UPS SubVersion.UPS uses sub version strategy to give back new elements in the response when there is no functionality change in the request or to enhance the existing functionality. Valid values are 1601, 1607, 1701, 1707.
This setting is only applicable when using UPS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TaxInformationIndicator: Controls whether to send a TaxInformationIndicator.This configuration setting controls whether to send a TaxInformationIndicator in the request or not. The default value is "false". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TotalCustomsValue: Invoice Line Total Monetary Value when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments.Required for forward shipments whose origin is the US and destination is Puerto Rico or Canada when using Mail Innovation service. Not available for any other shipments. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseSOAP: Whether or not to use UPS' webservices.When set to True (default) the class will construct the request for UPS' SOAP web service, otherwise the request will be constructed for UPS' XML service. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
USPSEndorsement:
The USPS endorsement type for Mail Innovations and SurePost shipments.This contains the USPS endorsement type and is required when using a Mail Innovations or SurePost ServiceType. The
Valid values are as follows:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
USPSPICNumber[i]:
USPS Tracking Number (corresponding to the package at index i).When creating a shipment using UPS Mail Innovations, a USPS tracking number will be
returned in the USPSPICNumber field in the response. This number should be used
when tracking packages.
Valid array indices are from 0 to PackageCount - 1. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VerbalConfirmationName:
The contact name for verbal confirmation.This sets the contact name for when verbal confirmation is requested.
If this is set, verbal confirmation will be requested and VerbalConfirmationPhone must also be set |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VerbalConfirmationPhone:
The contact phone number for verbal confirmation.This sets the contact phone number for when verbal confirmation is requested.
If this is set, verbal confirmation will be requested and VerbalConfirmationName must also be set |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Warning: Warning message returned by the server.This might be returned by the server even upon successful response. These warnings are usually informational. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WeightUnit:
Weight unit.It declares the type of weight unit to be used in calculating the weight of the shipment and each package contained in it.
Valid weight types are: LBS and KGS. Defaults to LBS if a value is not passed in the transaction. Depending on the selected country, the following measurement systems are valid: KGS/CM or LBS/IN (on domestic shipments, only the later combination is applicable). So, if the WeightUnit is set to KGS, its unit of measurements is set automatically to CM. Otherwise, it is set to IN (LBS/IN). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 (Upsshipintl Class)
UPSShipIntl Errors
301 Operation interrupted (or timeout). | |
432 Invalid index. | |
527 Server Error Response. | |
528 Property set with invalid data. | |
560 Missing data. |
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. |