USPSShipIntl Component
Properties Methods Events Configuration Settings Errors
Allows you to generate a USPS shipping label for any of USPS international services complete with addresses and barcode.
Syntax
nsoftware.InShip.Uspsshipintl
Remarks
Generating a shipping label can be done by calling the GetPackageLabel method. You will have to specify the package information, USPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Hold For Pickup, Return Shipment, etc.), and any other specific information on international shipments.
This component also allows you to request customs forms through the GetFormCN22 and GetFormCP72 methods.
To use this component, you must have a USPS account. You should also have already obtained a UserId and Password uniquely assigned to your account by USPS.
This component also includes Endicia support to print labels and postage through their web services. To use this service, you must have an Endicia AccountNumber. You should also have already obtained a UserId and Password uniquely assigned to your account by Endicia. The PostageProvider property must be set to ppEndicia to tell the component to use the Endicia protocol.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| BarcodeNumber | Barcode number required by Customs Service. |
| CertificateNumber | Certificate number (if known or included in the package). |
| Comments | Comments on the package being shipped. |
| Commodities | Items being shipped inside this package. |
| Contents | Description of items being shipped. |
| CountryOfOrigin | Country where the goods originated. |
| CustomerId | User-assigned number for internal use. |
| CustomsFormFile | Filename where the customs form required to mail to destination country can be saved to (optional). |
| CustomsFormInstructions | Image of customs form instructions. |
| CustomsFormInstructionsFile | Filename and location to save the CustomsFormInstructions to. |
| DeliveryType | Sender's selection of the type of delivery. |
| Firewall | A set of properties related to firewall access. |
| HSTariffNumber | HS Tariff Number that applies to the entire contents of the package being shipped. |
| ImageLayout | Determines how the labels will be formatted for printing. |
| IndemnityCoverage | Indicates the indemnity coverage for the package. |
| InsurancePolicy | Insurance number, if known. |
| InvoiceNumber | Invoice number if known or included in the package. |
| LabelImageType | Type of label image. |
| LicenseNumber | Import License number if known, or included in package. |
| MailingLocation | Postal Office Zip Code where the item will be mailed (if different from ZipCode ). |
| NonDeliveryOption | Indicates what to do with the package in case it is undeliverable. |
| Notes | Additional information returned by the USPS Server . |
| Observations | Additional mailing information based on country of destination. |
| Packages | A collection of packages contained in the shipment. |
| PostageProvider | The postage provider to use. |
| Prohibitions | List of items prohibited from mailing to the destination country. |
| Proxy | A set of properties related to proxy access. |
| RecipientAddress | Identifies the recipient's address. |
| RecipientContact | Identifies the recipient's contact info. |
| RecipientCustomsReference | Corresponds to the person's Customs Reference field that appears on the shipping label. |
| Regulations | Additional regulations for shipping to the destination country. |
| RequiredCustomsForms | Customs forms required to mail packages to destination country. |
| Restrictions | Restrictions on items being shipped based on country of destination. |
| SDRInsuredValue | Insurance amount, if known. |
| SDRValue | Special Drawing Right calculated on TotalValue . |
| SenderAddress | Identifies the sender's address. |
| SenderContact | Identifies the sender's contact info. |
| SenderCustomsReference | Corresponds to the person's Customs Reference field that appears on the shipping label. |
| ServiceType | The mail service type when shipping to the CountryCode . |
| ShipDate | Date package will be mailed. |
| ShipmentSpecialServices | Contains the collection of special services offered by USPS on shipment level. |
| SSLAcceptServerCert | Instructs the 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. |
| TotalValue | Total value of all items being shipped. |
| TransactionId | The transaction Id. |
| USPSAccount | Login information for USPS. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| GetFormCN22 | Retrieves Customs Form CN 22 providing customs barcode number, regulations, prohibitions, observations, restrictions, and image files of the customs forms required to ship to the destination country. |
| GetFormCP72 | Retrieves Customs Form CP 72 providing customs barcode number, regulations, prohibitions, observations, restrictions, and image files of the customs forms required to ship to the destination country. |
| GetPackageLabel | Generates a shipping label for the first package in the shipment. |
| Reset | Resets the internal state of the component and all properties to their default values. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Notification | Notification returned by the server upon successful request (if applicable). |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| RawRequest | Contains the complete request sent to USPS. |
| RawResponse | Contains the complete response returned by the USPS server. |
| XPath | Used to retrieve data at any place within the response. |
| RequesterId | The Requester Id to be used for Endicia requests. |
| Certify | Certify/Test mode for label components. |
| ImageParameters | For future use. |
| LabelImageResolution | The resolution of the label. |
| LabelImageRotation | The rotation of the label. |
| LabelSize | The size of the label. |
| Overwrite | Determines whether label files will be overwritten. |
| EndiciaInsuranceType | The Insurance type when using Endicia. |
| EntryFacility | Postal facility where mail is entered. |
| POZipCode | ZIP Code of Post Office. |
| EscapeEndiciaXML | Whether to escape XML special characters when using Endicia. |
| IncludePostage | Used to determine if the postage will be printed on the label. |
| SortType | Sort level for applicable mail classes. |
| RubberStamp1 | Customer defined data to be printed on label. |
| RubberStamp2 | Customer defined data to be printed on label. |
| RubberStamp3 | Customer defined data to be printed on label. |
| UseStealth | Used to determine if the postage price is printed on the label. |
| AddOnCount | Total number of AddOns. |
| PackageShippingLabelCount[i] | Total number of labels and / or custom forms returned in the response for each package. |
| PackageShippingLabelIndex[i] | Image of the shipping label return by the Server upon a successful ship response for each package. |
| AddOnTypes | The AddOn type to be requested. |
| AddOnType[i] | Indicates the AddOn type. |
| AddOnDescription[i] | Indicates the AddOn description. |
| AddOnAmount[i] | Indicates the AddOn amount. |
| AddOnAggregate[i] | Indicates the AddOn raw XML. |
| DeclaredValue | The amount to declare. |
| IntegratorTxId | Stamps.com transaction integrator Id. |
| StampsTxId | Stamps.com transaction identifier. |
| PackageLabelUrl | Stams.com label Url. |
| CommercialPrice | Indicates whether the commercial price should be returned. |
| CustomsFormType | The customs form type of the label. |
| CustomsSigner | The name of the person certifying the customs information is correct. |
| EndiciaPrintConsolidatorLabel | Used to request Consolidator Services. |
| HoldForManifest | Holds manifest record for inclusion in SCAN request. |
| PackageSize[i] | Indicates the package reference type and value, that associates this package. |
| PackageReference[i] | Indicates the package reference type and value, that associates this package. |
| OtherContents | Description of the contents. |
| RecipientAddress3 | Recipient's address line 3. |
| RecipientAddress4 | Recipient's address line 4. |
| RecipientAPOFPOZip | APO/FPO ZIP code for Military Mail. |
| RecipientAPOFPOZip4 | APO/FPO ZIP4 code for Military Mail. |
| APOFPOServiceType | APO/FPO Service Type for Military Mail. |
| SenderUrbanization | The Urbanization that the package is being shipped from. |
| UseInsurance | Specifies whether or not to request insurance. |
| AltReturnAddress1 | Alternate return address 1. |
| AltReturnAddress2 | Alternate return address 2. |
| AltReturnAddress3 | Alternate return address 3. |
| AltReturnAddress4 | Alternate return address 4. |
| AltReturnAddress5 | Alternate return address 5. |
| AltReturnAddress6 | Alternate return address 6. |
| AltReturnCountry | Alternate return country. |
| 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. |