UPSShipIntl Component
Properties Methods Events Configuration Settings Errors
Allows you to generate a UPS shipping label for any of UPS international services complete with addresses and barcode, cancel shipments.
Syntax
nsoftware.InShip.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 component 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 component, 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 component 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 | 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 component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| Timeout | A timeout for the component. |
| 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 component 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 component 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 component with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Notification | Notification returned by the server upon successful request (if applicable). |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| RawRequest | Contains the complete request sent to the Server. |
| RawResponse | Contains the complete response returned by the Server. |
| XPath | Used to retrieve data at any place within the response. |
| Warning | Warning message returned by the server. |
| UseSOAP | Whether or not to use UPS' webservices. |
| AccountTotalNetCharge | Net sum of negotiated rates applied to the whole shipment (if applicable). |
| 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. |
| CurrencyCode | The currency code associated with the monetary values present in the request. |
| HighValueReportFileName | Name of High Value Report (if applicable). |
| HighValueReport | High Value Report (if applicable). |
| IrregularIndicator | The mail classification defined by UPS. |
| LabelSize | The size of the label. |
| Machineable | Determines whether the package is machineable or not. |
| MICostCenter | Customer assigned identifier for report and billing summarization displays to the right of the Cost Center title. |
| MIPackageID | Customer assigned unique piece identifier that returns visibility events. |
| Overwrite | Determines whether label files will be overwritten. |
| PackageDeclaredValueType[i] | The type of declared value (corresponding to the package at index i). |
| PackageShippingLabelHTML[i] | HTML version of the shipping label (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. |
| PickupFloorNumber | The floor number of the pickup location. |
| PickupRoomNumber | The room number of the pickup location. |
| RequestOption | Defines if the address should be validated or not. |
| ReturnsFlexibleAccessIndicator | Defines if the Returns Flexible Access service should be used. |
| ElectronicReturnLabel | Indicates that you are arranging for UPS to email a return label to your customer. |
| 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. |
| 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. |
| ShippingLabelHTMLDirectory | The name of the directory where the shipping label files are written. |
| PickupEarliestTime | The earliest time a shipment is ready to be picked up. |
| PickupLatestTime | The latest time a shipment can be picked up. |
| AccountAddress3 | Contains line three details for the Account Address. |
| RecipientAddress3 | Contains line three details for the Recipient Address. |
| SenderAddress3 | Contains line three details for the Sender Address. |
| USPSEndorsement | The USPS endorsement type for Mail Innovations and SurePost shipments. |
| TotalCustomsValue | Invoice Line Total Monetary Value when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments. |
| ShipmentDescription | A textual description of goods for the whole shipment when shipping to Puerto Rico or Canada using Mail Innovations domestic 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. |
| WeightUnit | Weight unit. |
| AccountTaxId | The Tax ID Number for the account holder. |
| AdditionalDocumentIndicator | Indicates that additional documents will be supplied. |
| Documents | Whether an international shipment contains documents of no commercial value. |
| DeclarationStatement | The declarations statement to be sent to the customs office. |
| ExportDate | The date the goods will be exiting the country. |
| ExportingCarrier | The name of the carrier that is exporting the shipment. |
| InvoiceDiscount | The discount to be subtracted from the total value on the 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. |
| MILabelCN22 | Determines whether the MILabelCN22Indicator is included in the request. |
| NAFTAExcludeFromForm[i] | Excludes the commodity from NAFTA form (corresponding to the commodity at index i). |
| 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. |
| CIPONumber | Purchase Order Number for Commercial Invoice. |
| RecipientTaxId | The Tax ID Number for the recipient. |
| SendDutiesPayor | Indicates whether to send the duties payor information or not. |
| SenderTaxId | The Tax ID Number for the sender. |
| 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. |
| ReturnFreightPrices | When true, UPS will use applicable freight pricing for shipments. |
| 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. |
| FRSPaymentType | Method of payment for the shipment. |
| FRSPaymentDescription | Description for the Ground Freight Pricing payment type. |
| FRSPaymentAccountNumber | The UPS account number for the payor. |
| FRSPaymentPostalCode | The postal code of the payor for the Ground Freight Pricing shipment. |
| FRSPaymentCountryCode | The country code of the payor for the Ground Freight Pricing shipment. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |